VTK  9.1.0
vtkImageProbeFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkImageProbeFilter.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 =========================================================================*/
36 #ifndef vtkImageProbeFilter_h
37 #define vtkImageProbeFilter_h
38 
39 #include "vtkDataSetAlgorithm.h"
40 #include "vtkImagingCoreModule.h" // For export macro
41 
44 class vtkImageData;
45 class vtkPointData;
46 
47 class VTKIMAGINGCORE_EXPORT vtkImageProbeFilter : public vtkDataSetAlgorithm
48 {
49 public:
52  void PrintSelf(ostream& os, vtkIndent indent) override;
53 
55 
64 
72 
74 
79  virtual void SetInterpolator(vtkAbstractImageInterpolator* interpolator);
80  virtual vtkAbstractImageInterpolator* GetInterpolator() { return this->Interpolator; }
82 
83 protected:
86 
88 
92 
96  void Probe(vtkDataSet* input, vtkImageData* source, vtkDataSet* output);
97 
102 
107 
110 
111 private:
112  vtkImageProbeFilter(const vtkImageProbeFilter&) = delete;
113  void operator=(const vtkImageProbeFilter&) = delete;
114 
115  class ProbePointsWorklet;
116  struct ProbePointsThreadLocal;
117 
122  void ProbePoints(vtkDataSet* input, vtkImageData* source, vtkPointData* outPD, vtkIdType startId,
123  vtkIdType endId, ProbePointsThreadLocal* threadLocal);
124 };
125 
126 #endif
vtkImageProbeFilter::MaskScalars
vtkUnsignedCharArray * MaskScalars
Definition: vtkImageProbeFilter.h:109
vtkPointData
represent and manipulate point attribute data
Definition: vtkPointData.h:142
vtkImageProbeFilter::InitializeForProbing
virtual void InitializeForProbing(vtkDataSet *input, vtkImageData *source, vtkDataSet *output)
Initialize the interpolator and the output arrays.
vtkIdType
int vtkIdType
Definition: vtkType.h:332
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:145
vtkImageProbeFilter::SetSourceConnection
void SetSourceConnection(vtkAlgorithmOutput *algOutput)
Specify the data set that will be probed at the input points.
vtkImageProbeFilter::GetInterpolator
virtual vtkAbstractImageInterpolator * GetInterpolator()
Set the interpolator to use.
Definition: vtkImageProbeFilter.h:80
vtkUnsignedCharArray
dynamic, self-adjusting array of unsigned char
Definition: vtkUnsignedCharArray.h:145
vtkImageProbeFilter::~vtkImageProbeFilter
~vtkImageProbeFilter() override
vtkImageProbeFilter::New
static vtkImageProbeFilter * New()
vtkDataSetAlgorithm
Superclass for algorithms that produce output of the same type as input.
Definition: vtkDataSetAlgorithm.h:49
vtkImageProbeFilter::GetSource
vtkDataObject * GetSource()
Specify the data set that will be probed at the input points.
vtkX3D::port
@ port
Definition: vtkX3D.h:453
vtkImageProbeFilter::DoProbing
void DoProbing(vtkDataSet *input, vtkImageData *source, vtkDataSet *output)
Probe appropriate points (InitializeForProbing() must be called first).
vtkImageProbeFilter::FillInputPortInformation
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:157
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:113
vtkImageProbeFilter::RequestInformation
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks for Information.
vtkImageProbeFilter
sample image values at specified point positions
Definition: vtkImageProbeFilter.h:48
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:166
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:183
vtkX3D::info
@ info
Definition: vtkX3D.h:382
vtkImageProbeFilter::Probe
void Probe(vtkDataSet *input, vtkImageData *source, vtkDataSet *output)
Equivalent to calling InitializeForProbing(); DoProbing().
vtkDataSetAlgorithm.h
vtkImageProbeFilter::Interpolator
vtkAbstractImageInterpolator * Interpolator
Definition: vtkImageProbeFilter.h:108
vtkImageProbeFilter::SetInterpolator
virtual void SetInterpolator(vtkAbstractImageInterpolator *interpolator)
Set the interpolator to use.
vtkAlgorithmOutput
Proxy object to connect input/output ports.
Definition: vtkAlgorithmOutput.h:66
vtkImageProbeFilter::SetSourceData
void SetSourceData(vtkDataObject *source)
Specify the data set that will be probed at the input points.
vtkImageProbeFilter::vtkImageProbeFilter
vtkImageProbeFilter()
source
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition: vtkBoostGraphAdapter.h:998
vtkImageProbeFilter::RequestData
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks the algorithm to do its work.
vtkAbstractImageInterpolator
interpolate data values from images
Definition: vtkAbstractImageInterpolator.h:47
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:169
vtkImageProbeFilter::RequestUpdateExtent
int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when each filter in the pipeline decides what portion of its inp...
vtkImageProbeFilter::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.