1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkSimpleImageToImageFilter
* @brief Generic image filter with one input.
*
* vtkSimpleImageToImageFilter is a filter which aims to avoid much
* of the complexity associated with vtkImageAlgorithm (i.e.
* support for pieces, multi-threaded operation). If you need to write
* a simple image-image filter which operates on the whole input, use
* this as the superclass. The subclass has to provide only an execute
* method which takes input and output as arguments. Memory allocation
* is handled in vtkSimpleImageToImageFilter. Also, you are guaranteed to
* have a valid input in the Execute(input, output) method. By default,
* this filter
* requests it's input's whole extent and copies the input's information
* (spacing, whole extent etc...) to the output. If the output's setup
* is different (for example, if it performs some sort of sub-sampling),
* ExecuteInformation has to be overwritten. As an example of how this
* can be done, you can look at vtkImageShrink3D::ExecuteInformation.
* For a complete example which uses templates to support generic data
* types, see vtkSimpleImageToImageFilter.
*
* @sa
* vtkImageAlgorithm vtkSimpleImageFilterExample
*/
#ifndef vtkSimpleImageToImageFilter_h
#define vtkSimpleImageToImageFilter_h
#include "vtkCommonExecutionModelModule.h" // For export macro
#include "vtkImageAlgorithm.h"
VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONEXECUTIONMODEL_EXPORT vtkSimpleImageToImageFilter : public vtkImageAlgorithm
{
public:
vtkTypeMacro(vtkSimpleImageToImageFilter, vtkImageAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent) override;
protected:
vtkSimpleImageToImageFilter();
~vtkSimpleImageToImageFilter() override;
// These are called by the superclass.
int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
// You don't have to touch this unless you have a good reason.
int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
// In the simplest case, this is the only method you need to define.
virtual void SimpleExecute(vtkImageData* input, vtkImageData* output) = 0;
private:
vtkSimpleImageToImageFilter(const vtkSimpleImageToImageFilter&) = delete;
void operator=(const vtkSimpleImageToImageFilter&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif
|