VTK  9.3.20240328
vtkImageAlgorithm.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
38 #ifndef vtkImageAlgorithm_h
39 #define vtkImageAlgorithm_h
40 
41 #include "vtkAlgorithm.h"
42 #include "vtkCommonExecutionModelModule.h" // For export macro
43 
44 VTK_ABI_NAMESPACE_BEGIN
45 class vtkDataSet;
46 class vtkImageData;
47 
48 class VTKCOMMONEXECUTIONMODEL_EXPORT vtkImageAlgorithm : public vtkAlgorithm
49 {
50 public:
52  void PrintSelf(ostream& os, vtkIndent indent) override;
53 
55 
60  virtual void SetOutput(vtkDataObject* d);
62 
70 
72 
80 
82 
88  vtkDataObject* GetInput() { return this->GetInput(0); }
91 
93 
98  virtual void AddInputData(vtkDataObject*);
99  virtual void AddInputData(int, vtkDataObject*);
101 
102 protected:
104  ~vtkImageAlgorithm() override;
105 
110  virtual int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
111  vtkInformationVector* outputVector);
112 
119 
121 
130  vtkInformationVector** inputVector, vtkInformationVector* outputVector);
131 
139  virtual int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
140  vtkInformationVector* outputVector);
141 
146  virtual void ExecuteDataWithInformation(vtkDataObject* output, vtkInformation* outInfo);
147 
149 
153  virtual void ExecuteData(vtkDataObject* output);
154  virtual void Execute();
156 
158 
162  virtual void AllocateOutputData(vtkImageData* out, vtkInformation* outInfo, int* uExtent);
165 
170  virtual void CopyAttributeData(
171  vtkImageData* in, vtkImageData* out, vtkInformationVector** inputVector);
172 
174 
182 
183 private:
184  vtkImageAlgorithm(const vtkImageAlgorithm&) = delete;
185  void operator=(const vtkImageAlgorithm&) = delete;
186 };
187 
188 VTK_ABI_NAMESPACE_END
189 #endif
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:161
general representation of visualization data
abstract class to specify dataset behavior
Definition: vtkDataSet.h:165
Generic algorithm superclass for image algs.
virtual void ExecuteDataWithInformation(vtkDataObject *output, vtkInformation *outInfo)
This is a convenience method that is implemented in many subclasses instead of RequestData.
vtkDataObject * GetInput()
Get a data object for one of the input port connections.
void SetInputData(vtkDataObject *)
Assign a data object as input.
void SetInputData(int, vtkDataObject *)
Assign a data object as input.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void AllocateOutputData(vtkImageData *out, vtkInformation *outInfo, int *uExtent)
Allocate the output data.
virtual void Execute()
This method is the old style execute method, provided for the sake of backwards compatibility with ol...
virtual void SetOutput(vtkDataObject *d)
Get the output data object for a port on this algorithm.
~vtkImageAlgorithm() override
virtual int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Subclasses can reimplement this method to translate the update extent requests from each output port ...
virtual int RequestUpdateTime(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void CopyInputArrayAttributesToOutput(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Convenience method to copy the scalar type and number of components from the input data to the output...
vtkTypeBool ProcessRequest(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Process a request from the executive.
virtual void AddInputData(int, vtkDataObject *)
Assign a data object as input.
virtual void AddInputData(vtkDataObject *)
Assign a data object as input.
virtual vtkImageData * AllocateOutputData(vtkDataObject *out, vtkInformation *outInfo)
Allocate the output data.
virtual int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Subclasses can reimplement this method to collect information from their inputs and set information f...
int FillInputPortInformation(int port, vtkInformation *info) override
These method should be reimplemented by subclasses that have more than a single input or single outpu...
int FillOutputPortInformation(int port, vtkInformation *info) override
These method should be reimplemented by subclasses that have more than a single input or single outpu...
vtkImageData * GetImageDataInput(int port)
Get a data object for one of the input port connections.
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called in response to a REQUEST_DATA request from the executive.
virtual void ExecuteData(vtkDataObject *output)
This method is the old style execute method, provided for the sake of backwards compatibility with ol...
virtual void CopyAttributeData(vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
Copy the other point and cell data.
vtkDataObject * GetInput(int port)
Get a data object for one of the input port connections.
vtkImageData * GetOutput()
Get the output data object for a port on this algorithm.
vtkImageData * GetOutput(int)
Get the output data object for a port on this algorithm.
topologically and geometrically regular array of data
Definition: vtkImageData.h:155
a simple class to control print indentation
Definition: vtkIndent.h:108
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
@ info
Definition: vtkX3D.h:376
@ port
Definition: vtkX3D.h:447
int vtkTypeBool
Definition: vtkABI.h:64