itkSparseFrequencyContainer2.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkSparseFrequencyContainer2_h
#define itkSparseFrequencyContainer2_h

#include <map>
#include "itkObjectFactory.h"
#include "itkObject.h"
#include "itkNumericTraits.h"
#include "itkMeasurementVectorTraits.h"
#include "ITKStatisticsExport.h"

namespace itk
{
namespace Statistics
{
class ITKStatistics_EXPORT SparseFrequencyContainer2:public Object
{
public:
  typedef SparseFrequencyContainer2  Self;
  typedef Object                     Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  itkTypeMacro(SparseFrequencyContainer2, Object);
  itkNewMacro(Self);

  typedef MeasurementVectorTraits::InstanceIdentifier InstanceIdentifier;

  typedef MeasurementVectorTraits::AbsoluteFrequencyType AbsoluteFrequencyType;

  typedef MeasurementVectorTraits::TotalAbsoluteFrequencyType TotalAbsoluteFrequencyType;

  typedef MeasurementVectorTraits::RelativeFrequencyType RelativeFrequencyType;

  typedef MeasurementVectorTraits::TotalRelativeFrequencyType TotalRelativeFrequencyType;

  typedef std::map< InstanceIdentifier, AbsoluteFrequencyType > FrequencyContainerType;
  typedef FrequencyContainerType::const_iterator
  FrequencyContainerConstIterator;

  void Initialize(SizeValueType length);

  void SetToZero();

  bool SetFrequency(const InstanceIdentifier id, const AbsoluteFrequencyType value);

  bool IncreaseFrequency(const InstanceIdentifier id,
                         const AbsoluteFrequencyType value);

  AbsoluteFrequencyType GetFrequency(const InstanceIdentifier id) const;

  TotalAbsoluteFrequencyType GetTotalFrequency()
  {
    return m_TotalFrequency;
  }

protected:
  SparseFrequencyContainer2();
  virtual ~SparseFrequencyContainer2() {}
  virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;

private:
  SparseFrequencyContainer2(const Self &) ITK_DELETE_FUNCTION;
  void operator=(const Self &) ITK_DELETE_FUNCTION;

  // Container of histogram
  FrequencyContainerType     m_FrequencyContainer;
  TotalAbsoluteFrequencyType m_TotalFrequency;
};  // end of class
} // end of namespace Statistics
} // end of namespace itk

#endif