ITK  5.0.0
Insight Segmentation and Registration Toolkit
itkScalarImageToHistogramGenerator.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
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 {
35 template< typename TImageType >
36 class ITK_TEMPLATE_EXPORT ScalarImageToHistogramGenerator:public Object
37 {
38 public:
39  ITK_DISALLOW_COPY_AND_ASSIGN(ScalarImageToHistogramGenerator);
40 
43  using Superclass = Object;
46 
49 
51  itkNewMacro(Self);
52 
53  using ImageType = TImageType;
56  using PixelType = typename ImageType::PixelType;
58 
61 
63 
66 
67 public:
68 
70  void Compute();
71 
74  void SetInput(const ImageType *);
75 
79  const HistogramType * GetOutput() const;
80 
82  void SetNumberOfBins(unsigned int numberOfBins);
83 
85  void SetMarginalScale(double marginalScale);
86 
90  void SetHistogramMin(RealPixelType minimumValue);
91 
95  void SetHistogramMax(RealPixelType maximumValue);
96 
100  void SetAutoHistogramMinimumMaximum(bool autoOnOff);
101 
102 protected:
104  ~ScalarImageToHistogramGenerator() override = default;
105  void PrintSelf(std::ostream & os, Indent indent) const override;
106 
107 private:
108 
110 
112 
113 };
114 } // end of namespace Statistics
115 } // end of namespace itk
116 
117 #ifndef ITK_MANUAL_INSTANTIATION
118 #include "itkScalarImageToHistogramGenerator.hxx"
119 #endif
120 
121 #endif
Light weight base class for most itk classes.
Define numeric traits for std::vector.
This class stores measurement vectors in the context of n-dimensional histogram.
Definition: itkHistogram.h:77
Computes the Histogram corresponding to a Sample.
typename NumericTraits< PixelType >::RealType RealPixelType
Control indentation during Print() invocation.
Definition: itkIndent.h:49
This class provides ListSample interface to ITK Image.
Base class for most ITK classes.
Definition: itkObject.h:60