VTK  9.3.0
vtkImageResliceMapper.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
20 #ifndef vtkImageResliceMapper_h
21 #define vtkImageResliceMapper_h
22 
23 #include "vtkImageMapper3D.h"
24 #include "vtkRenderingImageModule.h" // For export macro
25 
26 VTK_ABI_NAMESPACE_BEGIN
28 class vtkRenderer;
29 class vtkRenderWindow;
30 class vtkCamera;
31 class vtkLookupTable;
32 class vtkImageSlice;
33 class vtkImageData;
35 class vtkMatrix4x4;
38 
39 class VTKRENDERINGIMAGE_EXPORT vtkImageResliceMapper : public vtkImageMapper3D
40 {
41 public:
44  void PrintSelf(ostream& os, vtkIndent indent) override;
45 
52  virtual void SetSlicePlane(vtkPlane* plane);
53 
55 
61  vtkSetMacro(JumpToNearestSlice, vtkTypeBool);
62  vtkBooleanMacro(JumpToNearestSlice, vtkTypeBool);
63  vtkGetMacro(JumpToNearestSlice, vtkTypeBool);
65 
67 
70  vtkSetMacro(SlabThickness, double);
71  vtkGetMacro(SlabThickness, double);
73 
75 
84  vtkSetClampMacro(SlabType, int, VTK_IMAGE_SLAB_MIN, VTK_IMAGE_SLAB_SUM);
85  vtkGetMacro(SlabType, int);
86  void SetSlabTypeToMin() { this->SetSlabType(VTK_IMAGE_SLAB_MIN); }
87  void SetSlabTypeToMax() { this->SetSlabType(VTK_IMAGE_SLAB_MAX); }
88  void SetSlabTypeToMean() { this->SetSlabType(VTK_IMAGE_SLAB_MEAN); }
89  void SetSlabTypeToSum() { this->SetSlabType(VTK_IMAGE_SLAB_SUM); }
90  virtual const char* GetSlabTypeAsString();
92 
94 
99  vtkSetClampMacro(SlabSampleFactor, int, 1, 2);
100  vtkGetMacro(SlabSampleFactor, int);
102 
104 
110  vtkSetClampMacro(ImageSampleFactor, int, 1, 16);
111  vtkGetMacro(ImageSampleFactor, int);
113 
115 
119  vtkSetMacro(AutoAdjustImageQuality, vtkTypeBool);
120  vtkBooleanMacro(AutoAdjustImageQuality, vtkTypeBool);
121  vtkGetMacro(AutoAdjustImageQuality, vtkTypeBool);
123 
125 
131  vtkSetMacro(ResampleToScreenPixels, vtkTypeBool);
132  vtkBooleanMacro(ResampleToScreenPixels, vtkTypeBool);
133  vtkGetMacro(ResampleToScreenPixels, vtkTypeBool);
135 
137 
143  vtkSetMacro(SeparateWindowLevelOperation, vtkTypeBool);
144  vtkBooleanMacro(SeparateWindowLevelOperation, vtkTypeBool);
145  vtkGetMacro(SeparateWindowLevelOperation, vtkTypeBool);
147 
149 
153  virtual void SetInterpolator(vtkAbstractImageInterpolator* interpolator);
156 
160  void Render(vtkRenderer* renderer, vtkImageSlice* prop) override;
161 
168 
172  vtkMTimeType GetMTime() override;
173 
175 
179  double* GetBounds() override;
180  void GetBounds(double bounds[6]) override { this->vtkAbstractMapper3D::GetBounds(bounds); }
182 
187  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
188 
189  // return the bounds in index space
190  void GetIndexBounds(double extent[6]) override;
191 
192 protected:
195 
199  void CheckerboardImage(vtkImageData* input, vtkCamera* camera, vtkImageProperty* property);
200 
205 
211 
216 
222 
227 
232 
237 
239 
242  void Update(int port) override;
243  void Update() override;
244  vtkTypeBool Update(int port, vtkInformationVector* requests) override;
245  vtkTypeBool Update(vtkInformation* requests) override;
247 
252 
253  vtkImageChangeInformation* ChangeInformation; // Prepare image for mapper
254  vtkImageSliceMapper* SliceMapper; // Does the OpenGL rendering
255 
256  vtkTypeBool JumpToNearestSlice; // Adjust SliceAtFocalPoint
257  vtkTypeBool AutoAdjustImageQuality; // LOD-style behavior
258  vtkTypeBool SeparateWindowLevelOperation; // Do window/level as a separate step
259  double SlabThickness; // Current slab thickness
260  int SlabType; // Current slab mode
261  int SlabSampleFactor; // Sampling factor for slab mode
262  int ImageSampleFactor; // Sampling factor for image pixels
263  vtkTypeBool ResampleToScreenPixels; // Use software interpolation only
264  int InternalResampleToScreenPixels; // Use software interpolation only
265  int ResliceNeedUpdate; // Execute reslice on next render
266  vtkImageResliceToColors* ImageReslice; // For software interpolation
267  vtkMatrix4x4* ResliceMatrix; // Cached reslice matrix
268  vtkMatrix4x4* WorldToDataMatrix; // World to Data transform matrix
269  vtkMatrix4x4* DataToSliceMatrix; // Data to Slice transform matrix
270  vtkMatrix4x4* SliceToWorldMatrix; // Slice to World transform matrix
272 
273 private:
275  void operator=(const vtkImageResliceMapper&) = delete;
276 };
277 
278 VTK_ABI_NAMESPACE_END
279 #endif
interpolate data values from images
virtual double * GetBounds()=0
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax,...
a virtual camera for 3D rendering
Definition: vtkCamera.h:41
Detect and break reference loops.
modify spacing, origin and extent.
topologically and geometrically regular array of data
Definition: vtkImageData.h:43
abstract class for mapping images to the screen
image display properties
map a slice of a vtkImageData to the screen
void CheckerboardImage(vtkImageData *input, vtkCamera *camera, vtkImageProperty *property)
Do a checkerboard pattern to the alpha of an RGBA image.
void GetIndexBounds(double extent[6]) override
vtkImageResliceToColors * ImageReslice
void UpdateResliceInformation(vtkRenderer *ren)
Set all of the reslicing parameters.
void UpdateResliceInterpolation(vtkImageProperty *property)
Set the interpolation.
vtkTypeBool Update(vtkInformation *requests) override
Override Update to handle some tricky details.
void SetSlabTypeToSum()
The slab type, for thick slicing (default: Mean).
vtkMTimeType GetMTime() override
Get the mtime for the mapper.
void Render(vtkRenderer *renderer, vtkImageSlice *prop) override
This should only be called by the renderer.
void SetSlabTypeToMean()
The slab type, for thick slicing (default: Mean).
virtual const char * GetSlabTypeAsString()
The slab type, for thick slicing (default: Mean).
static vtkImageResliceMapper * New()
vtkTypeBool SeparateWindowLevelOperation
void GetBounds(double bounds[6]) override
The bounding box (array of six doubles) of the data expressed as (xmin,xmax, ymin,...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void SetSlicePlane(vtkPlane *plane)
Set the slice that will be used to cut through the image.
void ReportReferences(vtkGarbageCollector *) override
Garbage collection for reference loops.
virtual void SetInterpolator(vtkAbstractImageInterpolator *interpolator)
Set a custom interpolator.
vtkImageSliceMapper * SliceMapper
void Update(int port) override
Override Update to handle some tricky details.
vtkTypeBool ProcessRequest(vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo) override
Handle requests from the pipeline executive.
vtkTypeBool Update(int port, vtkInformationVector *requests) override
Override Update to handle some tricky details.
void UpdateResliceMatrix(vtkRenderer *ren, vtkImageSlice *prop)
Update the reslice matrix, which is the slice-to-data matrix.
virtual vtkAbstractImageInterpolator * GetInterpolator()
Set a custom interpolator.
void Update() override
Override Update to handle some tricky details.
void UpdateWorldToDataMatrix(vtkImageSlice *prop)
Check if the vtkProp3D matrix has changed, and if so, set the WorldToDataMatrix to its inverse.
void UpdatePolygonCoords(vtkRenderer *ren)
Make a polygon by cutting the data bounds with a plane.
vtkImageChangeInformation * ChangeInformation
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this mapper.
double * GetBounds() override
The bounding box (array of six doubles) of the data expressed as (xmin,xmax, ymin,...
void UpdateColorInformation(vtkImageProperty *property)
Update anything related to the image coloring.
void UpdateSliceToWorldMatrix(vtkCamera *camera)
Update the slice-to-world matrix from the camera.
void SetSlabTypeToMax()
The slab type, for thick slicing (default: Mean).
void SetSlabTypeToMin()
The slab type, for thick slicing (default: Mean).
~vtkImageResliceMapper() override
Reslice and produce color scalars.
map a slice of a vtkImageData to the screen
represents an image in a 3D scene
Definition: vtkImageSlice.h:39
a simple class to control print indentation
Definition: vtkIndent.h:29
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
map scalar values into colors via a lookup table
represent and manipulate 4x4 transformation matrices
Definition: vtkMatrix4x4.h:31
perform various plane computations
Definition: vtkPlane.h:26
create a window for renderers to draw into
abstract specification for renderers
Definition: vtkRenderer.h:62
record modification and/or execution time
Definition: vtkTimeStamp.h:25
window superclass for vtkRenderWindow
Definition: vtkWindow.h:28
@ port
Definition: vtkX3D.h:447
@ extent
Definition: vtkX3D.h:345
int vtkTypeBool
Definition: vtkABI.h:64
#define VTK_IMAGE_SLAB_MAX
#define VTK_IMAGE_SLAB_MIN
#define VTK_IMAGE_SLAB_SUM
#define VTK_IMAGE_SLAB_MEAN
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:270