VTK  9.2.6
vtkAlgorithm.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkAlgorithm.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
35#ifndef vtkAlgorithm_h
36#define vtkAlgorithm_h
37
38#include "vtkCommonExecutionModelModule.h" // For export macro
39#include "vtkObject.h"
40
42class vtkAlgorithmInternals;
44class vtkCollection;
45class vtkDataArray;
46class vtkDataObject;
47class vtkExecutive;
48class vtkInformation;
55
56class VTKCOMMONEXECUTIONMODEL_EXPORT vtkAlgorithm : public vtkObject
57{
58public:
59 static vtkAlgorithm* New();
60 vtkTypeMacro(vtkAlgorithm, vtkObject);
61 void PrintSelf(ostream& os, vtkIndent indent) override;
62
84 {
87 DEFAULT_PRECISION
88 };
89
95
101
107 virtual void SetExecutive(vtkExecutive* executive);
108
133 vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
134
140 vtkInformation* request, vtkCollection* inInfo, vtkInformationVector* outInfo);
141
148 vtkInformationVector* outInfoVec, int requestFromOutputPort, vtkMTimeType* mtime);
149
157 virtual int ModifyRequest(vtkInformation* request, int when);
158
166
174
176
179 vtkGetObjectMacro(Information, vtkInformation);
182
187
192
194
197 bool UsesGarbageCollector() const override { return true; }
199
201
205 vtkSetMacro(AbortExecute, vtkTypeBool);
206 vtkGetMacro(AbortExecute, vtkTypeBool);
207 vtkBooleanMacro(AbortExecute, vtkTypeBool);
209
211
214 vtkGetMacro(Progress, double);
216
222 void UpdateProgress(double amount);
223
225
237 void SetProgressShiftScale(double shift, double scale);
238 vtkGetMacro(ProgressShift, double);
239 vtkGetMacro(ProgressScale, double);
241
243
250 void SetProgressText(const char* ptext);
251 vtkGetStringMacro(ProgressText);
253
255
259 vtkGetMacro(ErrorCode, unsigned long);
261
262 // left public for performance since it is used in inner loops
264
294
304
318
320
329 int idx, int port, int connection, int fieldAssociation, const char* name);
331 int idx, int port, int connection, int fieldAssociation, int fieldAttributeType);
332 virtual void SetInputArrayToProcess(int idx, vtkInformation* info);
334
358 virtual void SetInputArrayToProcess(int idx, int port, int connection,
359 const char* fieldAssociation, const char* attributeTypeorName);
360
365
366 // from here down are convenience methods that really are executive methods
367
372
378
383 vtkDataObject* GetInputDataObject(int port, int connection);
384
386
399 virtual void SetInputConnection(int port, vtkAlgorithmOutput* input);
402
404
413 virtual void AddInputConnection(int port, vtkAlgorithmOutput* input);
416
426 virtual void RemoveInputConnection(int port, vtkAlgorithmOutput* input);
427
431 virtual void RemoveInputConnection(int port, int idx);
432
436 virtual void RemoveAllInputConnections(int port);
437
446 virtual void SetInputDataObject(int port, vtkDataObject* data);
447 virtual void SetInputDataObject(vtkDataObject* data) { this->SetInputDataObject(0, data); }
448
454 virtual void AddInputDataObject(int port, vtkDataObject* data);
455 virtual void AddInputDataObject(vtkDataObject* data) { this->AddInputDataObject(0, data); }
456
465
470
475
480
485 vtkAlgorithm* GetInputAlgorithm(int port, int index, int& algPort);
486
490 vtkAlgorithm* GetInputAlgorithm(int port, int index);
491
496
501 vtkExecutive* GetInputExecutive(int port, int index);
502
507
516 vtkInformation* GetInputInformation(int port, int index);
517
522
531
533
536 virtual void Update(int port);
537 virtual void Update();
539
562 virtual vtkTypeBool Update(int port, vtkInformationVector* requests);
563
570
577 virtual int UpdatePiece(
578 int piece, int numPieces, int ghostLevels, const int extents[6] = nullptr);
579
585 virtual int UpdateExtent(const int extents[6]);
586
593 virtual int UpdateTimeStep(double time, int piece = -1, int numPieces = 1, int ghostLevels = 0,
594 const int extents[6] = nullptr);
595
599 virtual void UpdateInformation();
600
604 virtual void UpdateDataObject();
605
609 virtual void PropagateUpdateExtent();
610
614 virtual void UpdateWholeExtent();
615
620 void ConvertTotalInputToPortConnection(int ind, int& port, int& conn);
621
622 //======================================================================
623 // The following block of code is to support old style VTK applications. If
624 // you are using these calls there are better ways to do it in the new
625 // pipeline
626 //======================================================================
627
629
632 virtual void SetReleaseDataFlag(int);
633 virtual int GetReleaseDataFlag();
637
638 //========================================================================
639
641
648 int UpdateExtentIsEmpty(vtkInformation* pinfo, int extentType);
650
656
658
663 int* GetUpdateExtent() VTK_SIZEHINT(6) { return this->GetUpdateExtent(0); }
664 int* GetUpdateExtent(int port) VTK_SIZEHINT(6);
665 void GetUpdateExtent(int& x0, int& x1, int& y0, int& y1, int& z0, int& z1)
666 {
667 this->GetUpdateExtent(0, x0, x1, y0, y1, z0, z1);
668 }
669 void GetUpdateExtent(int port, int& x0, int& x1, int& y0, int& y1, int& z0, int& z1);
670 void GetUpdateExtent(int extent[6]) { this->GetUpdateExtent(0, extent); }
671 void GetUpdateExtent(int port, int extent[6]);
673
675
680 int GetUpdatePiece() { return this->GetUpdatePiece(0); }
681 int GetUpdatePiece(int port);
684 int GetUpdateGhostLevel() { return this->GetUpdateGhostLevel(0); }
685 int GetUpdateGhostLevel(int port);
687
689
699 vtkGetObjectMacro(ProgressObserver, vtkProgressObserver);
701
702protected:
704 ~vtkAlgorithm() override;
705
706 // Keys used to indicate that input/output port information has been
707 // filled.
709
710 // Arbitrary extra information associated with this algorithm
712
718 virtual int FillInputPortInformation(int port, vtkInformation* info);
719
725 virtual int FillOutputPortInformation(int port, vtkInformation* info);
726
730 virtual void SetNumberOfInputPorts(int n);
731
735 virtual void SetNumberOfOutputPorts(int n);
736
737 // Helper methods to check input/output port index ranges.
738 int InputPortIndexInRange(int index, const char* action);
739 int OutputPortIndexInRange(int index, const char* action);
740
746
748
756 int GetInputArrayAssociation(int idx, int connection, vtkInformationVector** inputVector);
759
761
767 int idx, vtkInformationVector** inputVector, int& association);
769
771
779 vtkDataArray* GetInputArrayToProcess(int idx, int connection, vtkInformationVector** inputVector);
781 int idx, int connection, vtkInformationVector** inputVector, int& association);
783 vtkDataArray* GetInputArrayToProcess(int idx, vtkDataObject* input, int& association);
785
787
793 int idx, vtkInformationVector** inputVector, int& association);
795
797
806 int idx, int connection, vtkInformationVector** inputVector);
808 int idx, int connection, vtkInformationVector** inputVector, int& association);
812
821
829
831
835 vtkSetMacro(ErrorCode, unsigned long);
836 unsigned long ErrorCode;
838
839 // Progress/Update handling
840 double Progress;
842
843 // Garbage collection support.
845
846 // executive methods below
847
854 virtual void SetNthInputConnection(int port, int index, vtkAlgorithmOutput* input);
855
862 virtual void SetNumberOfInputConnections(int port, int n);
863
865
872 void SetInputDataInternal(int port, vtkDataObject* input)
873 {
874 this->SetInputDataObject(port, input);
875 }
876 void AddInputDataInternal(int port, vtkDataObject* input)
877 {
878 this->AddInputDataObject(port, input);
879 }
880
882
883private:
884 vtkExecutive* Executive;
885 vtkInformationVector* InputPortInformation;
886 vtkInformationVector* OutputPortInformation;
887 vtkAlgorithmInternals* AlgorithmInternal;
888 static void ConnectionAdd(
889 vtkAlgorithm* producer, int producerPort, vtkAlgorithm* consumer, int consumerPort);
890 static void ConnectionRemove(
891 vtkAlgorithm* producer, int producerPort, vtkAlgorithm* consumer, int consumerPort);
892 static void ConnectionRemoveAllInput(vtkAlgorithm* consumer, int port);
893 static void ConnectionRemoveAllOutput(vtkAlgorithm* producer, int port);
894
895private:
896 vtkAlgorithm(const vtkAlgorithm&) = delete;
897 void operator=(const vtkAlgorithm&) = delete;
898
899 double ProgressShift;
900 double ProgressScale;
901};
902
903#endif
Abstract superclass for all arrays.
Proxy object to connect input/output ports.
Superclass for all sources, filters, and sinks in VTK.
virtual void UpdateDataObject()
Create output object(s).
vtkAlgorithmOutput * GetInputConnection(int port, int index)
Get the algorithm output port connected to an input port.
int GetUpdatePiece(int port)
These functions return the update extent for output ports that use piece extents.
void UpdateProgress(double amount)
Update the progress of the process object.
vtkInformation * GetInputArrayInformation(int idx)
Get the info object for the specified input array to this algorithm.
int GetInputArrayAssociation(int idx, vtkInformationVector **inputVector)
Get the association of the actual data array for the input array specified by idx,...
virtual void RemoveInputConnection(int port, vtkAlgorithmOutput *input)
Remove a connection from the given input port index.
vtkDataArray * GetInputArrayToProcess(int idx, int connection, vtkInformationVector **inputVector)
Filters that have multiple connections on one port can use this signature.
vtkAbstractArray * GetInputAbstractArrayToProcess(int idx, vtkInformationVector **inputVector)
Get the actual data array for the input array specified by idx, this is only reasonable during the RE...
virtual void SetNumberOfOutputPorts(int n)
Set the number of output ports provided by the algorithm.
virtual void SetNthInputConnection(int port, int index, vtkAlgorithmOutput *input)
Replace the Nth connection on the given input port.
int GetUpdateGhostLevel()
These functions return the update extent for output ports that use piece extents.
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.
vtkInformation * GetOutputPortInformation(int port)
Get the information object associated with an output port.
int GetInputArrayAssociation(int idx, vtkDataObject *input)
Filters that have multiple connections on one port can use this signature.
virtual void AddInputDataObject(vtkDataObject *data)
virtual void SetInputDataObject(vtkDataObject *data)
int UpdateExtentIsEmpty(vtkInformation *pinfo, int extentType)
This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateE...
int UpdateExtentIsEmpty(vtkInformation *pinfo, vtkDataObject *output)
This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateE...
void GetUpdateExtent(int extent[6])
These functions return the update extent for output ports that use 3D extents.
vtkInformation * GetInputArrayFieldInformation(int idx, vtkInformationVector **inputVector)
This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vec...
int GetUpdatePiece()
These functions return the update extent for output ports that use piece extents.
vtkInformation * Information
virtual vtkTypeBool Update(vtkInformation *requests)
Convenience method to update an algorithm after passing requests to its first output port.
virtual int FillOutputPortInformation(int port, vtkInformation *info)
Fill the output port information objects for this algorithm.
vtkDataObject * GetOutputDataObject(int port)
Get the data object that will contain the algorithm output for the given port.
vtkExecutive * GetInputExecutive()
Equivalent to GetInputExecutive(0, 0)
vtkExecutive * GetInputExecutive(int port, int index)
Returns the executive associated with a particular input connection.
virtual void RemoveAllInputConnections(int port)
Removes all input connections.
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.
virtual void AddInputConnection(vtkAlgorithmOutput *input)
Add a connection to the given input port index.
virtual vtkTypeBool Update(int port, vtkInformationVector *requests)
This method enables the passing of data requests to the algorithm to be used during execution (in add...
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.
vtkAbstractArray * GetInputAbstractArrayToProcess(int idx, int connection, vtkInformationVector **inputVector, int &association)
Filters that have multiple connections on one port can use this signature.
virtual void SetInputArrayToProcess(int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
String based versions of SetInputArrayToProcess().
static vtkInformationIntegerKey * PORT_REQUIREMENTS_FILLED()
virtual vtkTypeBool ProcessRequest(vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
Upstream/Downstream requests form the generalized interface through which executives invoke a algorit...
int GetNumberOfOutputPorts()
Get the number of output ports provided by the algorithm.
virtual int ModifyRequest(vtkInformation *request, int when)
This method gives the algorithm a chance to modify the contents of a request before or after (specifi...
void ReleaseDataFlagOff()
Turn release data flag on or off for all output ports.
void SetInputDataInternal(int port, vtkDataObject *input)
These methods are used by subclasses to implement methods to set data objects directly as input.
int GetNumberOfInputPorts()
Get the number of input ports used by the algorithm.
int GetInputArrayAssociation(int idx, int connection, vtkInformationVector **inputVector)
Filters that have multiple connections on one port can use this signature.
void ReleaseDataFlagOn()
Turn release data flag on or off for all output ports.
void SetProgressShiftScale(double shift, double scale)
Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is call...
vtkDataArray * GetInputArrayToProcess(int idx, int connection, vtkInformationVector **inputVector, int &association)
Filters that have multiple connections on one port can use this signature.
vtkDataArray * GetInputArrayToProcess(int idx, vtkInformationVector **inputVector, int &association)
Get the actual data array for the input array specified by idx, this is only reasonable during the RE...
vtkInformation * GetInputInformation()
Equivalent to GetInputInformation(0, 0)
unsigned long ErrorCode
The error code contains a possible error that occurred while reading or writing the file.
void GetUpdateExtent(int port, int extent[6])
These functions return the update extent for output ports that use 3D extents.
vtkInformation * GetOutputInformation(int port)
Return the information object that is associated with a particular output port.
vtkInformation * GetInputPortInformation(int port)
Get the information object associated with an input port.
int GetUpdateGhostLevel(int port)
These functions return the update extent for output ports that use piece extents.
int * GetUpdateExtent(int port)
These functions return the update extent for output ports that use 3D extents.
virtual void SetInputArrayToProcess(int idx, int port, int connection, int fieldAssociation, const char *name)
Set the input data arrays that this algorithm will process.
virtual void AddInputDataObject(int port, vtkDataObject *data)
Add the data-object as an input to this given port.
virtual vtkExecutive * CreateDefaultExecutive()
Create a default executive.
vtkAlgorithmOutput * GetOutputPort()
int OutputPortIndexInRange(int index, const char *action)
static void SetDefaultExecutivePrototype(vtkExecutive *proto)
If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using Ne...
vtkAlgorithm * GetInputAlgorithm()
Equivalent to GetInputAlgorithm(0, 0).
void ReportReferences(vtkGarbageCollector *) override
char * ProgressText
vtkAbstractArray * GetInputAbstractArrayToProcess(int idx, int connection, vtkInformationVector **inputVector)
Filters that have multiple connections on one port can use this signature.
vtkAlgorithm * GetInputAlgorithm(int port, int index)
Returns the algorithm connected to a port-index pair.
static vtkAlgorithm * New()
void SetProgressObserver(vtkProgressObserver *)
If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
virtual void SetInputArrayToProcess(int idx, vtkInformation *info)
Set the input data arrays that this algorithm will process.
vtkDataArray * GetInputArrayToProcess(int idx, vtkInformationVector **inputVector)
Get the actual data array for the input array specified by idx, this is only reasonable during the RE...
virtual int FillInputPortInformation(int port, vtkInformation *info)
Fill the input port information objects for this algorithm.
virtual void UpdateWholeExtent()
Bring this algorithm's outputs up-to-date.
virtual void SetNumberOfInputConnections(int port, int n)
Set the number of input connections on the given input port.
virtual void SetInputConnection(int port, vtkAlgorithmOutput *input)
Set the connection for the given input port index.
int GetTotalNumberOfInputConnections()
Get the total number of inputs for this algorithm.
vtkDataArray * GetInputArrayToProcess(int idx, vtkDataObject *input)
Filters that have multiple connections on one port can use this signature.
virtual void SetInputConnection(vtkAlgorithmOutput *input)
Set the connection for the given input port index.
void ConvertTotalInputToPortConnection(int ind, int &port, int &conn)
Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
virtual void SetExecutive(vtkExecutive *executive)
Set this algorithm's executive.
bool UsesGarbageCollector() const override
Participate in garbage collection.
int GetNumberOfInputConnections(int port)
Get the number of inputs currently connected to a port.
void SetProgressText(const char *ptext)
Set the current text message associated with the progress state.
virtual void PropagateUpdateExtent()
Propagate meta-data upstream.
virtual void Update(int port)
Bring this algorithm's outputs up-to-date.
vtkTypeBool AbortExecute
vtkExecutive * GetExecutive()
Get this algorithm's executive.
virtual int UpdateExtent(const int extents[6])
Convenience method to update an algorithm after passing requests to its first output port.
int GetUpdateNumberOfPieces()
These functions return the update extent for output ports that use piece extents.
vtkTypeBool ProcessRequest(vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
Version of ProcessRequest() that is wrapped.
DesiredOutputPrecision
Values used for setting the desired output precision for various algorithms.
virtual void SetReleaseDataFlag(int)
Turn release data flag on or off for all output ports.
virtual void SetInputDataObject(int port, vtkDataObject *data)
Sets the data-object as an input on the given port index.
vtkAbstractArray * GetInputAbstractArrayToProcess(int idx, vtkInformationVector **inputVector, int &association)
Get the actual data array for the input array specified by idx, this is only reasonable during the RE...
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.
vtkDataArray * GetInputArrayToProcess(int idx, vtkDataObject *input, int &association)
Filters that have multiple connections on one port can use this signature.
virtual void SetNumberOfInputPorts(int n)
Set the number of input ports used by the algorithm.
vtkAbstractArray * GetInputAbstractArrayToProcess(int idx, vtkDataObject *input, int &association)
Filters that have multiple connections on one port can use this signature.
virtual void RemoveInputConnection(int port, int idx)
Remove a connection given by index idx.
virtual void SetInputArrayToProcess(int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
Set the input data arrays that this algorithm will process.
int HasExecutive()
Check whether this algorithm has an assigned executive.
vtkAbstractArray * GetInputAbstractArrayToProcess(int idx, vtkDataObject *input)
Filters that have multiple connections on one port can use this signature.
int * GetUpdateExtent()
These functions return the update extent for output ports that use 3D extents.
vtkProgressObserver * ProgressObserver
virtual int GetReleaseDataFlag()
Turn release data flag on or off for all output ports.
vtkDataObject * GetInputDataObject(int port, int connection)
Get the data object that will contain the algorithm input for the given port and given connection.
virtual void UpdateInformation()
Bring the algorithm's information up-to-date.
vtkAlgorithmOutput * GetOutputPort(int index)
Get a proxy object corresponding to the given output port of this algorithm.
void AddInputDataInternal(int port, vtkDataObject *input)
~vtkAlgorithm() override
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int GetUpdateNumberOfPieces(int port)
These functions return the update extent for output ports that use piece extents.
int InputPortIndexInRange(int index, const char *action)
vtkInformation * GetInputInformation(int port, int index)
Return the information object that is associated with a particular input connection.
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.
virtual void SetInformation(vtkInformation *)
Set/Get the information object associated with this algorithm.
virtual void Update()
Bring this algorithm's outputs up-to-date.
static vtkExecutive * DefaultExecutivePrototype
virtual void AddInputConnection(int port, vtkAlgorithmOutput *input)
Add a connection to the given input port index.
void RemoveAllInputs()
Remove all the input data.
vtkAlgorithm * GetInputAlgorithm(int port, int index, int &algPort)
Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
create and manipulate ordered lists of objects
abstract superclass for arrays of numeric data
general representation of visualization data
Superclass for all pipeline executives in VTK.
Detect and break reference loops.
a simple class to control print indentation
Definition vtkIndent.h:34
Key for integer values in vtkInformation.
Key for string values in vtkInformation.
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
abstract base class for most VTK objects
Definition vtkObject.h:57
Basic class to optionally replace vtkAlgorithm progress functionality.
static vtkInformationStringVectorKey * INPUT_REQUIRED_DATA_TYPE()
static vtkInformationIntegerKey * INPUT_IS_OPTIONAL()
Keys used to specify input port requirements.
static vtkInformationIntegerKey * CAN_HANDLE_PIECE_REQUEST()
Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static vtkInformationIntegerKey * INPUT_PORT()
static vtkInformationInformationVectorKey * INPUT_REQUIRED_FIELDS()
static vtkInformationInformationVectorKey * INPUT_ARRAYS_TO_PROCESS()
static vtkInformationIntegerKey * INPUT_CONNECTION()
static vtkInformationIntegerKey * CAN_PRODUCE_SUB_EXTENT()
This key tells the executive that a particular output port is capable of producing an arbitrary subex...
static vtkInformationIntegerKey * INPUT_IS_REPEATABLE()
int vtkTypeBool
Definition vtkABI.h:69
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:287
#define VTK_SIZEHINT(...)