itkListSample.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 itkListSample_h
#define itkListSample_h
 
#include "itkObjectFactory.h"
#include "itkFixedArray.h"
#include "itkSample.h"
 
#include <vector>
 
namespace itk::Statistics
{
 
template <typename TMeasurementVector>
class ITK_TEMPLATE_EXPORT ListSample : public Sample<TMeasurementVector>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ListSample);

  using Self = ListSample;
  using Superclass = Sample<TMeasurementVector>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(ListSample);

  itkNewMacro(Self);

  using typename Superclass::MeasurementVectorType;
  using typename Superclass::MeasurementVectorSizeType;
  using typename Superclass::MeasurementType;
  using typename Superclass::AbsoluteFrequencyType;
  using typename Superclass::TotalAbsoluteFrequencyType;
  using typename Superclass::InstanceIdentifier;

  using ValueType = MeasurementVectorType;

  using InternalDataContainerType = std::vector<MeasurementVectorType>;

  void
  Resize(InstanceIdentifier newsize);

  void
  Clear();

  void
  PushBack(const MeasurementVectorType & mv);

  InstanceIdentifier
  Size() const override;

  const MeasurementVectorType &
  GetMeasurementVector(InstanceIdentifier instanceId) const override;

  void
  SetMeasurement(InstanceIdentifier instanceId, unsigned int dim, const MeasurementType & value);

  void
  SetMeasurementVector(InstanceIdentifier instanceId, const MeasurementVectorType & mv);

  AbsoluteFrequencyType
  GetFrequency(InstanceIdentifier instanceId) const override;

  TotalAbsoluteFrequencyType
  GetTotalFrequency() const override;

  void
  Graft(const DataObject * thatObject) override;

  class ConstIterator
  {
    friend class ListSample;
 
  public:
    ConstIterator(const ListSample * sample) { *this = sample->Begin(); }
 
    ConstIterator(const ConstIterator & iter)
      : m_Iter(iter.m_Iter)
      , m_InstanceIdentifier(iter.m_InstanceIdentifier)
    {}
 
    ConstIterator() = delete;
 
    ConstIterator &
    operator=(const ConstIterator & iter) = default;
 
    [[nodiscard]] AbsoluteFrequencyType
    GetFrequency() const
    {
      return 1;
    }
 
    [[nodiscard]] const MeasurementVectorType &
    GetMeasurementVector() const
    {
      return static_cast<const MeasurementVectorType &>(*m_Iter);
    }
 
    [[nodiscard]] InstanceIdentifier
    GetInstanceIdentifier() const
    {
      return m_InstanceIdentifier;
    }
 
    ConstIterator &
    operator++()
    {
      ++m_Iter;
      ++m_InstanceIdentifier;
      return *this;
    }
 
    bool
    operator==(const ConstIterator & it) const
    {
      return (m_Iter == it.m_Iter);
    }
 
    ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(ConstIterator);
 
  protected:
    // This method should only be available to the ListSample class
    ConstIterator(typename InternalDataContainerType::const_iterator iter, InstanceIdentifier iid)
      : m_Iter(iter)
      , m_InstanceIdentifier(iid)
    {}
 
  private:
    using InternalIterator = typename InternalDataContainerType::const_iterator;
    InternalIterator   m_Iter;
    InstanceIdentifier m_InstanceIdentifier;
  };

  class Iterator : public ConstIterator
  {
    friend class ListSample;
 
  public:
    Iterator() = delete;
    Iterator(const Self * sample) = delete;
    Iterator(typename InternalDataContainerType::const_iterator iter, InstanceIdentifier iid) = delete;
    Iterator(const ConstIterator & it) = delete;
    ConstIterator &
    operator=(const ConstIterator & it) = delete;
 
    Iterator(Self * sample)
      : ConstIterator(sample)
    {}
 
    Iterator(const Iterator & iter)
      : ConstIterator(iter)
    {}
 
    Iterator &
    operator=(const Iterator & iter)
    {
      this->ConstIterator::operator=(iter);
      return *this;
    }
 
  protected:
    Iterator(typename InternalDataContainerType::iterator iter, InstanceIdentifier iid)
      : ConstIterator(iter, iid)
    {}
  };

  Iterator
  Begin()
  {
    const Iterator iter(m_InternalContainer.begin(), 0);
 
    return iter;
  }

  Iterator
  End()
  {
    const Iterator iter(m_InternalContainer.end(), static_cast<InstanceIdentifier>(m_InternalContainer.size()));
 
    return iter;
  }

  ConstIterator
  Begin() const
  {
    const ConstIterator iter(m_InternalContainer.begin(), 0);
 
    return iter;
  }

  ConstIterator
  End() const
  {
    const ConstIterator iter(m_InternalContainer.end(), static_cast<InstanceIdentifier>(m_InternalContainer.size()));
 
    return iter;
  }
 
protected:
  ListSample() = default;
  ~ListSample() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  InternalDataContainerType m_InternalContainer{};
};
} // namespace itk::Statistics
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkListSample.hxx"
#endif
 
#endif