ITK  5.3.0
Insight Toolkit
itkScalarImageToHistogramGenerator.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef itkScalarImageToHistogramGenerator_h
19 #define itkScalarImageToHistogramGenerator_h
20 
23 #include "itkHistogram.h"
24 #include "itkObject.h"
25 
26 namespace itk
27 {
28 namespace Statistics
29 {
36 template <typename TImageType>
37 class ITK_TEMPLATE_EXPORT ScalarImageToHistogramGenerator : public Object
38 {
39 public:
40  ITK_DISALLOW_COPY_AND_MOVE(ScalarImageToHistogramGenerator);
41 
44  using Superclass = Object;
47 
50 
52  itkNewMacro(Self);
53 
54  using ImageType = TImageType;
57  using PixelType = typename ImageType::PixelType;
59 
62 
64 
67 
68 public:
70  void
71  Compute();
72 
75  void
76  SetInput(const ImageType *);
77 
81  const HistogramType *
82  GetOutput() const;
83 
85  void
86  SetNumberOfBins(unsigned int numberOfBins);
87 
89  void
90  SetMarginalScale(double marginalScale);
91 
95  void
96  SetHistogramMin(RealPixelType minimumValue);
97 
101  void
102  SetHistogramMax(RealPixelType maximumValue);
103 
107  void
108  SetAutoHistogramMinimumMaximum(bool autoOnOff);
109 
110 protected:
112  ~ScalarImageToHistogramGenerator() override = default;
113  void
114  PrintSelf(std::ostream & os, Indent indent) const override;
115 
116 private:
118 
120 };
121 } // end of namespace Statistics
122 } // end of namespace itk
123 
124 #ifndef ITK_MANUAL_INSTANTIATION
125 # include "itkScalarImageToHistogramGenerator.hxx"
126 #endif
127 
128 #endif
itk::Statistics::ScalarImageToHistogramGenerator
TODO.
Definition: itkScalarImageToHistogramGenerator.h:37
itk::Statistics::ImageToListSampleAdaptor
This class provides ListSample interface to ITK Image.
Definition: itkImageToListSampleAdaptor.h:54
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::Statistics::ScalarImageToHistogramGenerator::PixelType
typename ImageType::PixelType PixelType
Definition: itkScalarImageToHistogramGenerator.h:57
itk::Statistics::ScalarImageToHistogramGenerator::m_HistogramGenerator
GeneratorPointer m_HistogramGenerator
Definition: itkScalarImageToHistogramGenerator.h:119
itk::Statistics::ScalarImageToHistogramGenerator::ImageType
TImageType ImageType
Definition: itkScalarImageToHistogramGenerator.h:54
itk::Statistics::Histogram
This class stores measurement vectors in the context of n-dimensional histogram.
Definition: itkHistogram.h:77
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itkSampleToHistogramFilter.h
itkHistogram.h
itk::Statistics::ScalarImageToHistogramGenerator::AdaptorPointer
typename AdaptorType::Pointer AdaptorPointer
Definition: itkScalarImageToHistogramGenerator.h:56
itk::Statistics::ScalarImageToHistogramGenerator::HistogramConstPointer
typename HistogramType::ConstPointer HistogramConstPointer
Definition: itkScalarImageToHistogramGenerator.h:66
itk::NumericTraits
Define additional traits for native types such as int or float.
Definition: itkNumericTraits.h:58
itk::Statistics::SampleToHistogramFilter
Computes the Histogram corresponding to a Sample.
Definition: itkSampleToHistogramFilter.h:68
itk::Statistics::ScalarImageToHistogramGenerator::m_ImageToListSampleAdaptor
AdaptorPointer m_ImageToListSampleAdaptor
Definition: itkScalarImageToHistogramGenerator.h:117
itkObject.h
itk::Statistics::ScalarImageToHistogramGenerator::GeneratorPointer
typename GeneratorType::Pointer GeneratorPointer
Definition: itkScalarImageToHistogramGenerator.h:63
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::Statistics::ScalarImageToHistogramGenerator::HistogramPointer
typename HistogramType::Pointer HistogramPointer
Definition: itkScalarImageToHistogramGenerator.h:65
itk::Object
Base class for most ITK classes.
Definition: itkObject.h:62
itk::Statistics::ScalarImageToHistogramGenerator::RealPixelType
typename NumericTraits< PixelType >::RealType RealPixelType
Definition: itkScalarImageToHistogramGenerator.h:58
itkImageToListSampleAdaptor.h