VTK  9.3.20240425
vtkImageStencilData.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
18#ifndef vtkImageStencilData_h
19#define vtkImageStencilData_h
20
21#include "vtkDataObject.h"
22#include "vtkImagingCoreModule.h" // For export macro
23
24VTK_ABI_NAMESPACE_BEGIN
25class VTKIMAGINGCORE_EXPORT vtkImageStencilData : public vtkDataObject
26{
27public:
30 void PrintSelf(ostream& os, vtkIndent indent) override;
31
32 void Initialize() override;
33 void DeepCopy(vtkDataObject* o) override;
34 void ShallowCopy(vtkDataObject* f) override;
36
40 int GetDataObjectType() override { return VTK_IMAGE_STENCIL_DATA; }
41
45 int GetExtentType() override { return VTK_3D_EXTENT; }
46
56 int GetNextExtent(int& r1, int& r2, int xMin, int xMax, int yIdx, int zIdx, int& iter);
57
64 int IsInside(int xIdx, int yIdx, int zIdx);
65
73 void InsertNextExtent(int r1, int r2, int yIdx, int zIdx);
74
83 void InsertAndMergeExtent(int r1, int r2, int yIdx, int zIdx);
84
88 void RemoveExtent(int r1, int r2, int yIdx, int zIdx);
89
91
97 vtkSetVector3Macro(Spacing, double);
98 vtkGetVector3Macro(Spacing, double);
100
102
108 vtkSetVector3Macro(Origin, double);
109 vtkGetVector3Macro(Origin, double);
111
113
118 void SetExtent(const int extent[6]);
119 void SetExtent(int x1, int x2, int y1, int y2, int z1, int z2);
120 vtkGetVector6Macro(Extent, int);
122
128
132 void Fill();
133
135
142
144
150
154 virtual void Add(vtkImageStencilData*);
155
161
167
172 virtual int Clip(int extent[6]);
173
174protected:
177
179 {
181 Erase
182 };
183
187 void LogicalOperationExtent(int r1, int r2, int yIdx, int zIdx, Operation operation);
188
193
199 void ChangeExtent(const int extent[6]);
200
205
207
210 double Spacing[3];
211 double Origin[3];
213
214 int Extent[6];
215
217
224
225private:
227 void operator=(const vtkImageStencilData&) = delete;
228
229 friend class vtkImageStencilIteratorFriendship;
230};
231
238class VTKIMAGINGCORE_EXPORT vtkImageStencilRaster
239{
240public:
244 vtkImageStencilRaster(const int wholeExtent[2]);
245
250
256 void PrepareForNewData(const int allocateExtent[2] = nullptr);
257
259
262 void InsertLine(const double pt1[2], const double pt2[2]);
264
269 void FillStencilData(vtkImageStencilData* data, const int extent[6], int xj = 0, int yj = 1);
270
274 void SetTolerance(double tol) { this->Tolerance = tol; }
275 double GetTolerance() { return this->Tolerance; }
276
277protected:
282 void PrepareExtent(int ymin, int ymax);
283
289 void InsertPoint(int y, double x, int i);
290
291 int Extent[2];
292 int UsedExtent[2];
293 double** Raster;
294 double Tolerance;
295
296private:
298 void operator=(const vtkImageStencilRaster&) = delete;
299};
300
301VTK_ABI_NAMESPACE_END
302#endif
general representation of visualization data
efficient description of an image stencil
void CopyInformationToPipeline(vtkInformation *info) override
Override these to handle origin, spacing, scalar type, and scalar number of components.
int NumberOfExtentEntries
The actual 'data' is stored here.
virtual int Clip(int extent[6])
Clip the stencil with the supplied extents.
void InsertAndMergeExtent(int r1, int r2, int yIdx, int zIdx)
Similar to InsertNextExtent, except that the extent (r1,r2) at yIdx, zIdx is merged with other extent...
void Initialize() override
Restore data object to initial state,.
void DeepCopy(vtkDataObject *o) override
The goal of the method is to copy the complete data from src into this object.
void LogicalOperationInPlace(vtkImageStencilData *stencil, Operation operation)
Combine with the given stencil, using the given operation.
void InsertNextExtent(int r1, int r2, int yIdx, int zIdx)
This method is used by vtkImageStencilDataSource to add an x sub extent [r1,r2] for the x row (yIdx,...
~vtkImageStencilData() override
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static vtkImageStencilData * New()
void Fill()
Fill the sub-extents.
void AllocateExtents()
Allocate space for the sub-extents.
void SetExtent(int x1, int x2, int y1, int y2, int z1, int z2)
Set the extent of the data.
void InternalImageStencilDataCopy(vtkImageStencilData *s)
int GetNextExtent(int &r1, int &r2, int xMin, int xMax, int yIdx, int zIdx, int &iter)
Given the total output x extent [xMin,xMax] and the current y, z indices, return each sub-extent [r1,...
static vtkImageStencilData * GetData(vtkInformationVector *v, int i=0)
Retrieve an instance of this class from an information object.
void CopyInformationFromPipeline(vtkInformation *info) override
Override these to handle origin, spacing, scalar type, and scalar number of components.
virtual void Add(vtkImageStencilData *)
Add merges the stencil supplied as argument into Self.
int GetDataObjectType() override
Returns VTK_IMAGE_STENCIL_DATA.
void RemoveExtent(int r1, int r2, int yIdx, int zIdx)
Remove the extent from (r1,r2) at yIdx, zIdx.
int IsInside(int xIdx, int yIdx, int zIdx)
Checks if an image index is inside the stencil.
int ** ExtentLists
The actual 'data' is stored here.
virtual void Subtract(vtkImageStencilData *)
Subtract removes the portion of the stencil, supplied as argument, that lies within Self from Self.
static vtkImageStencilData * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
void LogicalOperationExtent(int r1, int r2, int yIdx, int zIdx, Operation operation)
Apply the given operation over the given (r1, r2) extent.
int * ExtentListLengths
The actual 'data' is stored here.
void CopyOriginAndSpacingFromPipeline(vtkInformation *info)
Get important info from pipeline.
void SetExtent(const int extent[6])
Set the extent of the data.
void ShallowCopy(vtkDataObject *f) override
The goal of the method is to copy the data up to the array pointers only.
int GetExtentType() override
The extent type is 3D, just like vtkImageData.
void ChangeExtent(const int extent[6])
Change the extent while preserving the data.
virtual void Replace(vtkImageStencilData *)
Replaces the portion of the stencil, supplied as argument, that lies within Self from Self.
This is a helper class for stencil creation.
void FillStencilData(vtkImageStencilData *data, const int extent[6], int xj=0, int yj=1)
Fill the specified extent of a vtkImageStencilData with the raster, after permuting the raster accord...
~vtkImageStencilRaster()
Destructor.
void SetTolerance(double tol)
The tolerance for float-to-int conversions.
void PrepareForNewData(const int allocateExtent[2]=nullptr)
Reset the raster to its original state, but keep the same whole extent.
void InsertLine(const double pt1[2], const double pt2[2])
Insert a line into the raster, given the two end points.
void PrepareExtent(int ymin, int ymax)
Ensure that the raster is initialized for the specified range of y values, which must be within the E...
vtkImageStencilRaster(const int wholeExtent[2])
Create a raster with the specified whole y extent.
void InsertPoint(int y, double x, int i)
Insert an x point into the raster.
a simple class to control print indentation
Definition vtkIndent.h:108
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
#define VTK_3D_EXTENT
#define VTK_IMAGE_STENCIL_DATA
Definition vtkType.h:113