itkSparseFrequencyContainer2.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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::Statistics
{
 
class ITKStatistics_EXPORT SparseFrequencyContainer2 : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(SparseFrequencyContainer2);

  using Self = SparseFrequencyContainer2;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(SparseFrequencyContainer2);
  itkNewMacro(Self);
  using InstanceIdentifier = MeasurementVectorTraits::InstanceIdentifier;

  using AbsoluteFrequencyType = MeasurementVectorTraits::AbsoluteFrequencyType;

  using TotalAbsoluteFrequencyType = MeasurementVectorTraits::TotalAbsoluteFrequencyType;

  using RelativeFrequencyType = MeasurementVectorTraits::RelativeFrequencyType;

  using TotalRelativeFrequencyType = MeasurementVectorTraits::TotalRelativeFrequencyType;

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

  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() const
  {
    return m_TotalFrequency;
  }
 
protected:
  SparseFrequencyContainer2();
  ~SparseFrequencyContainer2() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  // Container of histogram
  FrequencyContainerType     m_FrequencyContainer{};
  TotalAbsoluteFrequencyType m_TotalFrequency{};
}; // end of class
} // namespace itk::Statistics
 
#endif