Orfeo Toolbox  4.0
itkHistogram.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 __itkHistogram_h
19 #define __itkHistogram_h
20 
21 #include <vector>
22 
23 #include "itkArray.h"
24 #include "itkSample.h"
27 
28 namespace itk
29 {
30 namespace Statistics
31 {
32 
75 template< typename TMeasurement = float,
76  typename TFrequencyContainer = DenseFrequencyContainer2 >
77 class Histogram:
78  public Sample< Array< TMeasurement > >
79 {
80 public:
81 
82  // This type serves as the indirect definition of MeasurementVectorType
84 
86  typedef Histogram Self;
90 
92  itkTypeMacro(Histogram, Sample);
93 
95  itkNewMacro(Self);
96 
98  typedef TMeasurement MeasurementType;
99 
104 
106 
108  typedef TFrequencyContainer FrequencyContainerType;
109  typedef typename FrequencyContainerType::Pointer FrequencyContainerPointer;
110 
112  typedef typename FrequencyContainerType::AbsoluteFrequencyType AbsoluteFrequencyType;
113  typedef typename FrequencyContainerType::TotalAbsoluteFrequencyType TotalAbsoluteFrequencyType;
114  typedef typename FrequencyContainerType::RelativeFrequencyType RelativeFrequencyType;
115  typedef typename FrequencyContainerType::TotalRelativeFrequencyType TotalRelativeFrequencyType;
116 
120 
124 
126  typedef std::vector< MeasurementType > BinMinVectorType;
127  typedef std::vector< MeasurementType > BinMaxVectorType;
128  typedef std::vector< BinMinVectorType > BinMinContainerType;
129  typedef std::vector< BinMaxVectorType > BinMaxContainerType;
130 
134  void Initialize(const SizeType & size);
135 
139  void Initialize(const SizeType & size, MeasurementVectorType & lowerBound,
140  MeasurementVectorType & upperBound);
141 
143  void SetToZero();
144 
148  itkLegacyMacro(const IndexType & GetIndex(const MeasurementVectorType & measurement) const);
149 
153  bool GetIndex(const MeasurementVectorType & measurement,
154  IndexType & index) const;
155 
159  const IndexType & GetIndex(InstanceIdentifier id) const;
160 
163  itkGetConstMacro(ClipBinsAtEnds, bool);
164 
167  itkSetMacro(ClipBinsAtEnds, bool);
168 
171  bool IsIndexOutOfBounds(const IndexType & index) const;
172 
177 
179  InstanceIdentifier Size() const;
180 
182  const SizeType & GetSize() const;
183 
185  SizeValueType GetSize(unsigned int dimension) const;
186 
188  const MeasurementType & GetBinMin(unsigned int dimension,
189  InstanceIdentifier nbin) const;
190 
192  const MeasurementType & GetBinMax(unsigned int dimension,
193  InstanceIdentifier nbin) const;
194 
196  void SetBinMin(unsigned int dimension, InstanceIdentifier nbin,
197  MeasurementType min);
198 
200  void SetBinMax(unsigned int dimension,
202 
205  const MeasurementType & GetBinMinFromValue(unsigned int dimension,
206  float value) const;
207 
210  const MeasurementType & GetBinMaxFromValue(unsigned int dimension,
211  float value) const;
212 
214  const BinMinVectorType & GetDimensionMins(unsigned int dimension) const;
215 
217  const BinMaxVectorType & GetDimensionMaxs(unsigned int dimension) const;
218 
220  const BinMinContainerType & GetMins() const;
221 
223  const BinMaxContainerType & GetMaxs() const;
224 
226  const MeasurementVectorType & GetHistogramMinFromIndex(const IndexType & index) const;
227 
229  const MeasurementVectorType & GetHistogramMaxFromIndex(const IndexType & index) const;
230 
233 
235  AbsoluteFrequencyType GetFrequency(const IndexType & index) const;
236 
239 
243 
246  bool SetFrequencyOfIndex(const IndexType & index,
247  AbsoluteFrequencyType value);
248 
251  bool SetFrequencyOfMeasurement(const MeasurementVectorType & measurement,
252  AbsoluteFrequencyType value);
253 
258 
262  bool IncreaseFrequencyOfIndex(const IndexType & index,
263  AbsoluteFrequencyType value);
264 
269  const MeasurementVectorType & measurement,
270  AbsoluteFrequencyType value);
271 #ifdef ITKV3_COMPATIBILITY
272  //In ITKv4 the member functions are given unique names to dis-ambiguate
273  //the intended behavior. Make aliases of the overloaded calls
274  //for ITKv3 backwards compatibility.
275  bool IncreaseFrequency(const IndexType & index,
276  AbsoluteFrequencyType value)
277  {
278  return IncreaseFrequencyOfIndex(index,value);
279  }
280 
281  bool IncreaseFrequency(
282  const MeasurementVectorType & measurement,
283  AbsoluteFrequencyType value)
284  {
285  return IncreaseFrequencyOfMeasurement(measurement,value);
286  }
287 
288 #endif
289 
294 
296  const MeasurementVectorType & GetMeasurementVector(const IndexType & index) const;
297 
301  unsigned int dimension) const;
302 
305 
308  unsigned int dimension) const;
309 
325  double Quantile(unsigned int dimension, double p) const;
326 
328  double Mean(unsigned int dimension) const;
329 
331  virtual void Graft(const DataObject *);
332 
333 protected:
334  void PrintSelf(std::ostream & os, Indent indent) const;
335 
336 public:
337 
343  {
344 public:
345 
346  friend class Histogram;
347 
348  ConstIterator(const Self *histogram)
349  {
350  m_Id = 0;
351  m_Histogram = histogram;
352  }
353 
355  {
356  m_Id = it.m_Id;
358  }
359 
361  {
362  m_Id = it.m_Id;
364  return *this;
365  }
366 
368  {
369  return m_Histogram->GetFrequency(m_Id);
370  }
371 
373  {
374  return m_Id;
375  }
376 
378  {
379  return m_Histogram->GetMeasurementVector(m_Id);
380  }
381 
382  const IndexType & GetIndex() const
383  {
384  return m_Histogram->GetIndex(m_Id);
385  }
386 
388  {
389  ++m_Id;
390  return *this;
391  }
392 
393  bool operator!=(const ConstIterator & it)
394  {
395  return ( m_Id != it.m_Id );
396  }
397 
398  bool operator==(const ConstIterator & it)
399  {
400  return ( m_Id == it.m_Id );
401  }
402 
403 protected:
404  // This method is purposely not implemented
405  ConstIterator();
406 
407  ConstIterator(InstanceIdentifier id, const Self *histogram):
408  m_Id(id), m_Histogram(histogram)
409  {}
410 
411  // ConstIterator pointing DenseFrequencyContainer
413 
414  // Pointer of DenseFrequencyContainer
416  }; // end of iterator class
417 
422  class Iterator:public ConstIterator
423  {
424 public:
425 
426  Iterator(Self *histogram):ConstIterator(histogram)
427  {}
428 
430  ConstIterator(id, histogram)
431  {}
432 
434  {}
435 
437  {
438  this->ConstIterator::operator=(it);
439  return *this;
440  }
441 
443  {
444  Self *histogram = const_cast< Self * >( this->m_Histogram );
445 
446  return histogram->SetFrequency(this->m_Id, value);
447  }
448 
449 protected:
450  // To ensure const-correctness these method must not be in the public API.
451  // The are purposly not implemented, since they should never be called.
452  Iterator();
453  Iterator(const Self *histogram);
454  Iterator(InstanceIdentifier id, const Self *histogram);
455  Iterator(const ConstIterator & it);
456  ConstIterator & operator=(const ConstIterator & it);
457 
458 private:
459  }; // end of iterator class
460 
462  {
463  Iterator iter(0, this);
464 
465  return iter;
466  }
467 
469  {
470  return Iterator(m_OffsetTable[this->GetMeasurementVectorSize()], this);
471  }
472 
474  {
475  ConstIterator iter(0, this);
476 
477  return iter;
478  }
479 
481  {
483  }
484 
485 protected:
486  Histogram();
487  virtual ~Histogram() {}
488 
489  // The number of bins for each dimension
491 
492 private:
493  Histogram(const Self &); //purposely not implemented
494  void operator=(const Self &); //purposely not implemented
495 
496  typedef std::vector< InstanceIdentifier > OffsetTableType;
499  unsigned int m_NumberOfInstances;
500 
501  // This method is provided here just to avoid a "hidden" warning
502  // related to the virtual method available in DataObject.
503  virtual void Initialize() {}
504 
505  // lower bound of each bin
506  std::vector< std::vector< MeasurementType > > m_Min;
507 
508  // upper bound of each bin
509  std::vector< std::vector< MeasurementType > > m_Max;
510 
513 
515 };
516 } // end of namespace Statistics
517 } // end of namespace itk
518 
519 #ifndef ITK_MANUAL_INSTANTIATION
520 #include "itkHistogram.hxx"
521 #endif
522 
523 #endif

Generated at Sat Mar 8 2014 14:47:14 for Orfeo Toolbox with doxygen 1.8.3.1