VTK  9.1.20211115
vtkImageClip.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkImageClip.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 =========================================================================*/
67 #ifndef vtkImageClip_h
68 #define vtkImageClip_h
69 
70 // I did not make this a subclass of in place filter because
71 // the references on the data do not matter. I make no modifications
72 // to the data.
73 #include "vtkImageAlgorithm.h"
74 #include "vtkImagingCoreModule.h" // For export macro
75 
76 class VTKIMAGINGCORE_EXPORT vtkImageClip : public vtkImageAlgorithm
77 {
78 public:
79  static vtkImageClip* New();
81  void PrintSelf(ostream& os, vtkIndent indent) override;
82 
84 
87  void SetOutputWholeExtent(int extent[6], vtkInformation* outInfo = nullptr);
88  void SetOutputWholeExtent(int minX, int maxX, int minY, int maxY, int minZ, int maxZ);
90  int* GetOutputWholeExtent() VTK_SIZEHINT(6) { return this->OutputWholeExtent; }
92 
94 
96 
101  vtkSetMacro(ClipData, vtkTypeBool);
102  vtkGetMacro(ClipData, vtkTypeBool);
103  vtkBooleanMacro(ClipData, vtkTypeBool);
105 
106 protected:
108  ~vtkImageClip() override = default;
109 
110  // Time when OutputImageExtent was computed.
112  int Initialized; // Set the OutputImageExtent for the first time.
113  int OutputWholeExtent[6];
114 
116 
118 
119  void CopyData(vtkImageData* inData, vtkImageData* outData, int* ext);
120 
122 
123 private:
124  vtkImageClip(const vtkImageClip&) = delete;
125  void operator=(const vtkImageClip&) = delete;
126 };
127 
128 #endif
Generic algorithm superclass for image algs.
Reduces the image extent of the input.
Definition: vtkImageClip.h:77
void CopyData(vtkImageData *inData, vtkImageData *outData, int *ext)
void ResetOutputWholeExtent()
void SetOutputWholeExtent(int minX, int maxX, int minY, int maxY, int minZ, int maxZ)
The whole extent of the output has to be set explicitly.
void GetOutputWholeExtent(int extent[6])
The whole extent of the output has to be set explicitly.
static vtkImageClip * New()
~vtkImageClip() override=default
vtkTimeStamp CTime
Definition: vtkImageClip.h:111
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int * GetOutputWholeExtent()
The whole extent of the output has to be set explicitly.
Definition: vtkImageClip.h:90
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Subclasses can reimplement this method to collect information from their inputs and set information f...
void SetOutputWholeExtent(int extent[6], vtkInformation *outInfo=nullptr)
The whole extent of the output has to be set explicitly.
vtkTypeBool ClipData
Definition: vtkImageClip.h:115
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called in response to a REQUEST_DATA request from the executive.
topologically and geometrically regular array of data
Definition: vtkImageData.h:157
a simple class to control print indentation
Definition: vtkIndent.h:113
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
record modification and/or execution time
Definition: vtkTimeStamp.h:52
@ extent
Definition: vtkX3D.h:351
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_SIZEHINT(...)