VTK  9.1.0
vtkImageStencilData.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkImageStencilData.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=========================================================================*/
46#ifndef vtkImageStencilData_h
47#define vtkImageStencilData_h
48
49#include "vtkDataObject.h"
50#include "vtkImagingCoreModule.h" // For export macro
51
52class VTKIMAGINGCORE_EXPORT vtkImageStencilData : public vtkDataObject
53{
54public:
57 void PrintSelf(ostream& os, vtkIndent indent) override;
58
59 void Initialize() override;
60 void DeepCopy(vtkDataObject* o) override;
61 void ShallowCopy(vtkDataObject* f) override;
63
67 int GetDataObjectType() override { return VTK_IMAGE_STENCIL_DATA; }
68
72 int GetExtentType() override { return VTK_3D_EXTENT; }
73
83 int GetNextExtent(int& r1, int& r2, int xMin, int xMax, int yIdx, int zIdx, int& iter);
84
91 int IsInside(int xIdx, int yIdx, int zIdx);
92
100 void InsertNextExtent(int r1, int r2, int yIdx, int zIdx);
101
110 void InsertAndMergeExtent(int r1, int r2, int yIdx, int zIdx);
111
115 void RemoveExtent(int r1, int r2, int yIdx, int zIdx);
116
118
124 vtkSetVector3Macro(Spacing, double);
125 vtkGetVector3Macro(Spacing, double);
127
129
135 vtkSetVector3Macro(Origin, double);
136 vtkGetVector3Macro(Origin, double);
138
140
145 void SetExtent(const int extent[6]);
146 void SetExtent(int x1, int x2, int y1, int y2, int z1, int z2);
147 vtkGetVector6Macro(Extent, int);
149
155
159 void Fill();
160
162
169
171
177
181 virtual void Add(vtkImageStencilData*);
182
188
194
199 virtual int Clip(int extent[6]);
200
201protected:
204
206 {
208 Erase
209 };
210
214 void LogicalOperationExtent(int r1, int r2, int yIdx, int zIdx, Operation operation);
215
220
226 void ChangeExtent(const int extent[6]);
227
232
234
237 double Spacing[3];
238 double Origin[3];
240
241 int Extent[6];
242
244
251
252private:
254 void operator=(const vtkImageStencilData&) = delete;
255
256 friend class vtkImageStencilIteratorFriendship;
257};
258
265class VTKIMAGINGCORE_EXPORT vtkImageStencilRaster
266{
267public:
271 vtkImageStencilRaster(const int wholeExtent[2]);
272
277
283 void PrepareForNewData(const int allocateExtent[2] = nullptr);
284
286
289 void InsertLine(const double pt1[2], const double pt2[2]);
291
296 void FillStencilData(vtkImageStencilData* data, const int extent[6], int xj = 0, int yj = 1);
297
301 void SetTolerance(double tol) { this->Tolerance = tol; }
302 double GetTolerance() { return this->Tolerance; }
303
304protected:
309 void PrepareExtent(int ymin, int ymax);
310
316 void InsertPoint(int y, double x, int i);
317
318 int Extent[2];
319 int UsedExtent[2];
320 double** Raster;
321 double Tolerance;
322
323private:
325 void operator=(const vtkImageStencilRaster&) = delete;
326};
327
328#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
Shallow and Deep copy.
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
Shallow and Deep copy.
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:113
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
#define VTK_3D_EXTENT
#define VTK_IMAGE_STENCIL_DATA
Definition: vtkType.h:125