VTK
|
Superclass for algorithms that produce only data object as output. More...
#include <vtkDataObjectAlgorithm.h>
Public Types | |
typedef vtkAlgorithm | Superclass |
![]() | |
typedef vtkObject | Superclass |
![]() | |
typedef vtkObjectBase | Superclass |
Public Member Functions | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
void | PrintSelf (ostream &os, vtkIndent indent) |
vtkDataObject * | GetInput () |
vtkDataObject * | GetInput (int port) |
vtkDataObject * | GetOutput () |
vtkDataObject * | GetOutput (int) |
virtual void | SetOutput (vtkDataObject *d) |
virtual int | ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
void | SetInput (vtkDataObject *) |
void | SetInput (int, vtkDataObject *) |
void | AddInput (vtkDataObject *) |
void | AddInput (int, vtkDataObject *) |
![]() | |
int | HasExecutive () |
vtkExecutive * | GetExecutive () |
virtual void | SetExecutive (vtkExecutive *executive) |
virtual int | ModifyRequest (vtkInformation *request, int when) |
vtkInformation * | GetInputPortInformation (int port) |
vtkInformation * | GetOutputPortInformation (int port) |
int | GetNumberOfInputPorts () |
int | GetNumberOfOutputPorts () |
void | UpdateProgress (double amount) |
vtkInformation * | GetInputArrayInformation (int idx) |
void | RemoveAllInputs () |
vtkDataObject * | GetOutputDataObject (int port) |
virtual void | RemoveInputConnection (int port, vtkAlgorithmOutput *input) |
int | GetNumberOfInputConnections (int port) |
int | GetTotalNumberOfInputConnections () |
vtkAlgorithmOutput * | GetInputConnection (int port, int index) |
virtual void | Update () |
virtual void | UpdateInformation () |
virtual void | UpdateWholeExtent () |
void | ConvertTotalInputToPortConnection (int ind, int &port, int &conn) |
virtual double | ComputePriority () |
int | ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo) |
virtual int | ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime) |
virtual vtkInformation * | GetInformation () |
virtual void | SetInformation (vtkInformation *) |
virtual void | Register (vtkObjectBase *o) |
virtual void | UnRegister (vtkObjectBase *o) |
virtual void | SetAbortExecute (int) |
virtual int | GetAbortExecute () |
virtual void | AbortExecuteOn () |
virtual void | AbortExecuteOff () |
virtual void | SetProgress (double) |
virtual double | GetProgress () |
void | SetProgressText (const char *ptext) |
virtual char * | GetProgressText () |
virtual unsigned long | GetErrorCode () |
virtual void | SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name) |
virtual void | SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType) |
virtual void | SetInputArrayToProcess (int idx, vtkInformation *info) |
virtual void | SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName) |
vtkDataObject * | GetInputDataObject (int port, int connection) |
virtual void | SetInputConnection (int port, vtkAlgorithmOutput *input) |
virtual void | SetInputConnection (vtkAlgorithmOutput *input) |
virtual void | AddInputConnection (int port, vtkAlgorithmOutput *input) |
virtual void | AddInputConnection (vtkAlgorithmOutput *input) |
vtkAlgorithmOutput * | GetOutputPort (int index) |
vtkAlgorithmOutput * | GetOutputPort () |
virtual void | SetReleaseDataFlag (int) |
virtual int | GetReleaseDataFlag () |
void | ReleaseDataFlagOn () |
void | ReleaseDataFlagOff () |
int | UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType) |
![]() | |
virtual void | DebugOn () |
virtual void | DebugOff () |
unsigned char | GetDebug () |
void | SetDebug (unsigned char debugFlag) |
virtual void | Modified () |
virtual unsigned long | GetMTime () |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
vtkCommand * | GetCommand (unsigned long tag) |
void | RemoveObserver (vtkCommand *) |
void | RemoveObservers (unsigned long event, vtkCommand *) |
void | RemoveObservers (const char *event, vtkCommand *) |
int | HasObserver (unsigned long event, vtkCommand *) |
int | HasObserver (const char *event, vtkCommand *) |
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) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
int | InvokeEvent (unsigned long event, void *callData) |
int | InvokeEvent (const char *event, void *callData) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
![]() | |
const char * | GetClassName () const |
virtual void | Delete () |
virtual void | FastDelete () |
void | Print (ostream &os) |
void | SetReferenceCount (int) |
void | PrintRevisions (ostream &os) |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
int | GetReferenceCount () |
Additional Inherited Members | |
![]() | |
int | AbortExecute |
![]() | |
static vtkInformationIntegerKey * | PORT_REQUIREMENTS_FILLED () |
![]() | |
vtkInformation * | Information |
double | Progress |
char * | ProgressText |
unsigned long | ErrorCode |
![]() | |
static vtkExecutive * | DefaultExecutivePrototype |
![]() |
Superclass for algorithms that produce only data object as output.
vtkDataObjectAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help transition old algorithms to the new pipeline architecture. Ther are some assumptions and defaults made by this class you should be aware of. This class defaults such that your filter will have one input port and one output port. If that is not the case simply change it with SetNumberOfInputPorts etc. See this classes constructor for the default. This class also provides a FillInputPortInfo method that by default says that all inputs will be DataObject. If that isn't the case then please override this method in your subclass. This class breaks out the downstream requests into seperate functions such as ExecuteData and ExecuteInformation. For new algorithms you should implement RequestData( request, inputVec, outputVec) but for older filters there is a default implementation that calls the old ExecuteData(output) signature, for even older filters that don;t implement ExecuteData the default implementation calls the even older Execute() signature.
Definition at line 45 of file vtkDataObjectAlgorithm.h.
Definition at line 49 of file vtkDataObjectAlgorithm.h.
|
protected |
|
protected |
|
static |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkDistributedDataFilter, vtkPassArrays, vtkDataSetToDataObjectFilter, vtkRCalculatorFilter, vtkReebGraphVolumeSkeletonFilter, vtkVolumeContourSpectrumFilter, vtkAreaContourSpectrumFilter, vtkMatlabEngineFilter, vtkReebGraphSurfaceSkeletonFilter, vtkExtractSelectedFrustum, vtkGenerateIndexArray, vtkStringToCategory, vtkNetCDFCFReader, vtkNetCDFReader, vtkExtractSelection, vtkExtractSelectedThresholds, vtkProgrammableDataObjectSource, vtkTimePointToString, vtkDataObjectGenerator, vtkStringToTimePoint, vtkStringToNumeric, vtkExtractSelectedIds, vtkExtractSelectedLocations, vtkReflectionFilter, vtkProbeSelectedLocations, vtkPReflectionFilter, and vtkExtractSelectedBlock.
|
virtual |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkPassArrays, vtkRCalculatorFilter, vtkReebGraphVolumeSkeletonFilter, vtkDataSetToDataObjectFilter, vtkMatlabEngineFilter, vtkVolumeContourSpectrumFilter, vtkAreaContourSpectrumFilter, vtkReebGraphSurfaceSkeletonFilter, vtkExtractSelectedFrustum, vtkGenerateIndexArray, vtkStringToCategory, vtkExtractSelection, vtkNetCDFCFReader, vtkNetCDFReader, vtkProgrammableDataObjectSource, vtkTimePointToString, vtkDataObjectGenerator, vtkStringToTimePoint, vtkExtractSelectedThresholds, vtkStringToNumeric, vtkExtractSelectedIds, vtkExtractSelectedLocations, vtkReflectionFilter, vtkProbeSelectedLocations, vtkPReflectionFilter, vtkExtractSelectionBase, and vtkExtractSelectedBlock.
|
static |
Return 1 if this class type 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 vtkAlgorithm.
Reimplemented in vtkPassArrays, vtkRCalculatorFilter, vtkReebGraphVolumeSkeletonFilter, vtkDataSetToDataObjectFilter, vtkMatlabEngineFilter, vtkVolumeContourSpectrumFilter, vtkAreaContourSpectrumFilter, vtkReebGraphSurfaceSkeletonFilter, vtkExtractSelectedFrustum, vtkGenerateIndexArray, vtkStringToCategory, vtkExtractSelection, vtkNetCDFCFReader, vtkNetCDFReader, vtkProgrammableDataObjectSource, vtkTimePointToString, vtkDataObjectGenerator, vtkStringToTimePoint, vtkExtractSelectedThresholds, vtkStringToNumeric, vtkExtractSelectedIds, vtkExtractSelectedLocations, vtkReflectionFilter, vtkProbeSelectedLocations, vtkPReflectionFilter, vtkExtractSelectionBase, and vtkExtractSelectedBlock.
|
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 vtkAlgorithm.
Reimplemented in vtkPassArrays, vtkRCalculatorFilter, vtkReebGraphVolumeSkeletonFilter, vtkDataSetToDataObjectFilter, vtkMatlabEngineFilter, vtkVolumeContourSpectrumFilter, vtkAreaContourSpectrumFilter, vtkReebGraphSurfaceSkeletonFilter, vtkExtractSelectedFrustum, vtkGenerateIndexArray, vtkStringToCategory, vtkExtractSelection, vtkNetCDFCFReader, vtkNetCDFReader, vtkProgrammableDataObjectSource, vtkTimePointToString, vtkDataObjectGenerator, vtkStringToTimePoint, vtkExtractSelectedThresholds, vtkStringToNumeric, vtkExtractSelectedIds, vtkExtractSelectedLocations, vtkReflectionFilter, vtkProbeSelectedLocations, vtkPReflectionFilter, vtkExtractSelectionBase, and vtkExtractSelectedBlock.
|
static |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkPassArrays, vtkRCalculatorFilter, vtkReebGraphVolumeSkeletonFilter, vtkDataSetToDataObjectFilter, vtkMatlabEngineFilter, vtkVolumeContourSpectrumFilter, vtkAreaContourSpectrumFilter, vtkReebGraphSurfaceSkeletonFilter, vtkExtractSelectedFrustum, vtkGenerateIndexArray, vtkStringToCategory, vtkExtractSelection, vtkNetCDFCFReader, vtkNetCDFReader, vtkProgrammableDataObjectSource, vtkTimePointToString, vtkDataObjectGenerator, vtkStringToTimePoint, vtkExtractSelectedThresholds, vtkStringToNumeric, vtkExtractSelectedIds, vtkExtractSelectedLocations, vtkReflectionFilter, vtkProbeSelectedLocations, vtkPReflectionFilter, vtkExtractSelectionBase, and vtkExtractSelectedBlock.
|
virtual |
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 vtkAlgorithm.
Reimplemented in vtkDistributedDataFilter, vtkPassArrays, vtkRCalculatorFilter, vtkReebGraphVolumeSkeletonFilter, vtkDataSetToDataObjectFilter, vtkMatlabEngineFilter, vtkVolumeContourSpectrumFilter, vtkAreaContourSpectrumFilter, vtkReebGraphSurfaceSkeletonFilter, vtkExtractSelectedFrustum, vtkGenerateIndexArray, vtkStringToCategory, vtkExtractSelection, vtkNetCDFCFReader, vtkNetCDFReader, vtkProgrammableDataObjectSource, vtkTimePointToString, vtkDataObjectGenerator, vtkStringToTimePoint, vtkExtractSelectedThresholds, vtkStringToNumeric, vtkExtractSelectedIds, vtkExtractSelectedLocations, vtkReflectionFilter, vtkProbeSelectedLocations, vtkPReflectionFilter, vtkExtractSelectionBase, and vtkExtractSelectedBlock.
vtkDataObject* vtkDataObjectAlgorithm::GetOutput | ( | ) |
Get the output data object for a port on this algorithm.
Reimplemented in vtkReebGraphVolumeSkeletonFilter, vtkVolumeContourSpectrumFilter, vtkAreaContourSpectrumFilter, and vtkReebGraphSurfaceSkeletonFilter.
vtkDataObject* vtkDataObjectAlgorithm::GetOutput | ( | int | ) |
Get the output data object for a port on this algorithm.
|
virtual |
Get the output data object for a port on this algorithm.
|
virtual |
see vtkAlgorithm for details
Reimplemented from vtkAlgorithm.
Reimplemented in vtkMatlabEngineFilter, vtkRCalculatorFilter, vtkPassArrays, vtkGenerateIndexArray, vtkStringToNumeric, vtkTimePointToString, vtkStringToCategory, and vtkStringToTimePoint.
vtkDataObject* vtkDataObjectAlgorithm::GetInput | ( | ) |
vtkDataObject* vtkDataObjectAlgorithm::GetInput | ( | int | port | ) |
void vtkDataObjectAlgorithm::SetInput | ( | vtkDataObject * | ) |
Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.
void vtkDataObjectAlgorithm::SetInput | ( | int | , |
vtkDataObject * | |||
) |
Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.
void vtkDataObjectAlgorithm::AddInput | ( | vtkDataObject * | ) |
Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
void vtkDataObjectAlgorithm::AddInput | ( | int | , |
vtkDataObject * | |||
) |
Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
|
protectedvirtual |
Reimplemented in vtkDistributedDataFilter, vtkNetCDFReader, vtkNetCDFCFReader, and vtkDataObjectGenerator.
|
inlineprotectedvirtual |
This is called by the superclass. This is the method you should override.
Reimplemented in vtkDistributedDataFilter, vtkNetCDFReader, vtkMatlabEngineFilter, vtkRCalculatorFilter, vtkPassArrays, vtkExtractSelectedFrustum, vtkNetCDFCFReader, vtkStringToNumeric, vtkGenerateIndexArray, vtkReflectionFilter, vtkExtractSelection, vtkTimePointToString, vtkStringToCategory, vtkStringToTimePoint, vtkDataObjectGenerator, vtkExtractSelectionBase, vtkProbeSelectedLocations, and vtkExtractSelectedBlock.
Definition at line 104 of file vtkDataObjectAlgorithm.h.
|
protectedvirtual |
Reimplemented in vtkDistributedDataFilter, vtkNetCDFReader, vtkStringToNumeric, vtkPassArrays, vtkNetCDFCFReader, vtkExtractSelectedFrustum, vtkGenerateIndexArray, vtkReflectionFilter, vtkExtractSelectedThresholds, vtkDataSetToDataObjectFilter, vtkReebGraphVolumeSkeletonFilter, vtkVolumeContourSpectrumFilter, vtkAreaContourSpectrumFilter, vtkReebGraphSurfaceSkeletonFilter, vtkTimePointToString, vtkExtractSelection, vtkStringToCategory, vtkStringToTimePoint, vtkProgrammableDataObjectSource, vtkDataObjectGenerator, vtkExtractSelectedIds, vtkProbeSelectedLocations, vtkExtractSelectedLocations, and vtkExtractSelectedBlock.
|
inlineprotectedvirtual |
This is called by the superclass. This is the method you should override.
Reimplemented in vtkDistributedDataFilter, vtkDataSetToDataObjectFilter, and vtkDataObjectGenerator.
Definition at line 119 of file vtkDataObjectAlgorithm.h.
|
protected |
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. The source uses this call to determine whether to call Execute.
Reimplemented from vtkAlgorithm.
|
protectedvirtual |
This method is the old style execute method
|
protectedvirtual |
This method is the old style execute method
|
protectedvirtual |
Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkReebGraphVolumeSkeletonFilter, vtkVolumeContourSpectrumFilter, vtkAreaContourSpectrumFilter, vtkReebGraphSurfaceSkeletonFilter, and vtkStringToCategory.
|
protectedvirtual |
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 vtkAlgorithm.
Reimplemented in vtkDistributedDataFilter, vtkDataSetToDataObjectFilter, vtkReflectionFilter, vtkReebGraphVolumeSkeletonFilter, vtkVolumeContourSpectrumFilter, vtkAreaContourSpectrumFilter, vtkReebGraphSurfaceSkeletonFilter, vtkExtractSelection, vtkExtractSelectionBase, vtkExtractSelectedIds, and vtkExtractSelectedBlock.