VTK  9.2.5
vtkImageHistogram.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkImageHistogram.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 =========================================================================*/
56 #ifndef vtkImageHistogram_h
57 #define vtkImageHistogram_h
58 
59 #include "vtkImagingStatisticsModule.h" // For export macro
61 
63 class vtkIdTypeArray;
64 class vtkImageHistogramThreadData;
65 class vtkImageHistogramSMPThreadLocal;
66 
67 class VTKIMAGINGSTATISTICS_EXPORT vtkImageHistogram : public vtkThreadedImageAlgorithm
68 {
69 public:
72 
73  void PrintSelf(ostream& os, vtkIndent indent) override;
74 
78  enum
79  {
80  Linear = 0,
81  Log = 1,
82  Sqrt = 2
83  };
84 
86 
91  vtkSetMacro(ActiveComponent, int);
92  vtkGetMacro(ActiveComponent, int);
94 
96 
107  vtkSetMacro(AutomaticBinning, vtkTypeBool);
108  vtkBooleanMacro(AutomaticBinning, vtkTypeBool);
109  vtkGetMacro(AutomaticBinning, vtkTypeBool);
111 
113 
121  vtkSetMacro(MaximumNumberOfBins, int);
122  vtkGetMacro(MaximumNumberOfBins, int);
124 
126 
130  vtkSetMacro(NumberOfBins, int);
131  vtkGetMacro(NumberOfBins, int);
133 
135 
139  vtkSetMacro(BinOrigin, double);
140  vtkGetMacro(BinOrigin, double);
142 
144 
148  vtkSetMacro(BinSpacing, double);
149  vtkGetMacro(BinSpacing, double);
151 
153 
159 
164 
166 
171  vtkSetMacro(GenerateHistogramImage, vtkTypeBool);
172  vtkBooleanMacro(GenerateHistogramImage, vtkTypeBool);
173  vtkGetMacro(GenerateHistogramImage, vtkTypeBool);
175 
177 
181  vtkSetVector2Macro(HistogramImageSize, int);
182  vtkGetVector2Macro(HistogramImageSize, int);
184 
186 
190  vtkSetClampMacro(HistogramImageScale, int, vtkImageHistogram::Linear, vtkImageHistogram::Sqrt);
191  void SetHistogramImageScaleToLinear() { this->SetHistogramImageScale(vtkImageHistogram::Linear); }
192  void SetHistogramImageScaleToLog() { this->SetHistogramImageScale(vtkImageHistogram::Log); }
193  void SetHistogramImageScaleToSqrt() { this->SetHistogramImageScale(vtkImageHistogram::Sqrt); }
194  vtkGetMacro(HistogramImageScale, int);
197 
203 
208  vtkIdType GetTotal() { return this->Total; }
209 
215  vtkInformationVector* outputVector, vtkImageData*** inData, vtkImageData** outData, int ext[6],
216  int id) override;
217 
218 protected:
220  ~vtkImageHistogram() override;
221 
222  int RequestUpdateExtent(vtkInformation* vtkNotUsed(request), vtkInformationVector** inInfo,
223  vtkInformationVector* vtkNotUsed(outInfo)) override;
224  int RequestInformation(vtkInformation* vtkNotUsed(request), vtkInformationVector** inInfo,
225  vtkInformationVector* vtkNotUsed(outInfo)) override;
227 
230 
237 
241 
242  int HistogramImageSize[2];
245 
247  double BinOrigin;
248  double BinSpacing;
249 
252 
253  // Used for vtkMultiThreader operation.
254  vtkImageHistogramThreadData* ThreadData;
255 
256  // Used for vtkSMPTools operation.
257  vtkImageHistogramSMPThreadLocal* SMPThreadData;
258 
259 private:
260  vtkImageHistogram(const vtkImageHistogram&) = delete;
261  void operator=(const vtkImageHistogram&) = delete;
262 
263  friend class vtkImageHistogramFunctor;
264 };
265 
266 #endif
Proxy object to connect input/output ports.
dynamic, self-adjusting array of vtkIdType
topologically and geometrically regular array of data
Definition: vtkImageData.h:163
Compute the histogram for an image.
vtkTypeBool GenerateHistogramImage
void SetStencilData(vtkImageStencilData *stencil)
Use a stencil to compute the histogram for just a part of the image.
void SetHistogramImageScaleToLog()
Set the scale to use for the histogram image.
int RequestUpdateExtent(vtkInformation *vtkNotUsed(request), vtkInformationVector **inInfo, vtkInformationVector *vtkNotUsed(outInfo)) override
int FillInputPortInformation(int port, vtkInformation *info) override
These method should be reimplemented by subclasses that have more than a single input or single outpu...
vtkImageHistogramThreadData * ThreadData
vtkTypeBool AutomaticBinning
void ThreadedRequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int ext[6], int id) override
This is part of the executive, but is public so that it can be accessed by non-member functions.
void ComputeImageScalarRange(vtkImageData *data, double range[2])
Compute the range of the data.
int FillOutputPortInformation(int port, vtkInformation *info) override
These method should be reimplemented by subclasses that have more than a single input or single outpu...
~vtkImageHistogram() override
void SetHistogramImageScaleToLinear()
Set the scale to use for the histogram image.
void SetStencilConnection(vtkAlgorithmOutput *algOutput)
Equivalent to SetInputConnection(1, algOutput).
static vtkImageHistogram * New()
vtkImageHistogramSMPThreadLocal * SMPThreadData
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
void SetHistogramImageScaleToSqrt()
Set the scale to use for the histogram image.
int RequestInformation(vtkInformation *vtkNotUsed(request), vtkInformationVector **inInfo, vtkInformationVector *vtkNotUsed(outInfo)) override
const char * GetHistogramImageScaleAsString()
Set the scale to use for the histogram image.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkIdTypeArray * Histogram
vtkIdTypeArray * GetHistogram()
Get the histogram as a vtkIdTypeArray.
vtkIdType GetTotal()
Get the total count of the histogram.
vtkImageStencilData * GetStencil()
Use a stencil to compute the histogram for just a part of the image.
efficient description of an image stencil
a simple class to control print indentation
Definition: vtkIndent.h:119
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Generic filter that has one input.
@ info
Definition: vtkX3D.h:382
@ port
Definition: vtkX3D.h:453
@ range
Definition: vtkX3D.h:244
@ data
Definition: vtkX3D.h:321
int vtkTypeBool
Definition: vtkABI.h:69
int vtkIdType
Definition: vtkType.h:332