itkMembershipSample.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 itkMembershipSample_h
#define itkMembershipSample_h

#include "itksys/hash_map.hxx"
#include "itkSubsample.h"

namespace itk
{
namespace Statistics
{
template< typename TSample >
class ITK_TEMPLATE_EXPORT MembershipSample:public DataObject
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(MembershipSample);

  using Self = MembershipSample;
  using Superclass = DataObject;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkTypeMacro(MembershipSample, DataObject);
  itkNewMacro(Self);

  using SampleType = TSample;
  using MeasurementVectorType = typename SampleType::MeasurementVectorType;
  using MeasurementType = typename SampleType::MeasurementType;
  using InstanceIdentifier = typename SampleType::InstanceIdentifier;
  using SampleConstPointer = typename SampleType::ConstPointer;

  using AbsoluteFrequencyType = typename SampleType::AbsoluteFrequencyType;
  using TotalAbsoluteFrequencyType = typename SampleType::TotalAbsoluteFrequencyType;

  using ClassLabelType = IdentifierType;
  using UniqueClassLabelsType = std::vector< ClassLabelType >;

  using ClassLabelHolderType = itksys::hash_map< InstanceIdentifier, ClassLabelType >;

  using ClassSampleType = Subsample< SampleType >;
  using ClassSamplePointer = typename ClassSampleType::Pointer;
  using ClassSampleConstPointer = typename ClassSampleType::ConstPointer;

  itkSetConstObjectMacro(Sample, SampleType);
  itkGetConstObjectMacro(Sample, SampleType);

  void SetNumberOfClasses(unsigned int numberOfClasses);

  itkGetConstMacro(NumberOfClasses, unsigned int);

  void AddInstance(const ClassLabelType & classLabel, const InstanceIdentifier & id);

  unsigned int GetClassLabel(const InstanceIdentifier & id) const;

  const ClassSampleType * GetClassSample(const ClassLabelType & classLabel) const;

  const ClassLabelHolderType GetClassLabelHolder() const;

  const MeasurementVectorType & GetMeasurementVector(const InstanceIdentifier & id) const;

  MeasurementType GetMeasurement(const InstanceIdentifier & id,
                                 const unsigned int & dimension);

  AbsoluteFrequencyType GetFrequency(const InstanceIdentifier & id) const;

  TotalAbsoluteFrequencyType GetTotalFrequency() const;

  void Graft(const DataObject *thatObject) override;

//  void PrintSelf(std::ostream& os, Indent indent) const;

  class ConstIterator
  {
    friend class MembershipSample;

public:

    ConstIterator(const Self *sample)
    {
      *this = sample->Begin();
    }

    ConstIterator(const ConstIterator & iter)
    {
      m_Sample = iter.m_Sample;
      m_MembershipSample = iter.m_MembershipSample;
      m_InstanceIdentifier = iter.m_InstanceIdentifier;
    }

    ConstIterator & operator=(const ConstIterator & iter)
    {
      m_Sample = iter.m_Sample;
      m_MembershipSample = iter.m_MembershipSample;
      m_InstanceIdentifier = iter.m_InstanceIdentifier;
      return *this;
    }

    bool operator!=(const ConstIterator & it)
    {
      return ( m_InstanceIdentifier != it.m_InstanceIdentifier );
    }

    bool operator==(const ConstIterator & it)
    {
      return ( m_InstanceIdentifier == it.m_InstanceIdentifier );
    }

    ConstIterator & operator++()
    {
      ++m_InstanceIdentifier;
      return *this;
    }

    AbsoluteFrequencyType GetFrequency() const
    {
      return m_Sample->GetFrequency(m_InstanceIdentifier);
    }

    const MeasurementVectorType & GetMeasurementVector() const
    {
      return m_Sample->GetMeasurementVector(m_InstanceIdentifier);
    }

    InstanceIdentifier GetInstanceIdentifier() const
    {
      return m_InstanceIdentifier;
    }

    unsigned int   GetClassLabel() const
    {
      return m_MembershipSample->GetClassLabel(m_InstanceIdentifier);
    }

protected:
    // Purposely not implemented
    ConstIterator();

    // Only to be called from the MembershipSample
    ConstIterator(
      const Self *memberSample, InstanceIdentifier iid):
      m_Sample( memberSample->GetSample() ), m_MembershipSample(memberSample), m_InstanceIdentifier(iid)
    {}

    //typename SampleType::ConstIterator m_Iter;
    const TSample *         m_Sample;
    const MembershipSample *m_MembershipSample;
    InstanceIdentifier      m_InstanceIdentifier;
  };

  class Iterator:public ConstIterator
  {
    friend class MembershipSample;

public:

    Iterator(Self *sample):ConstIterator(sample)
    {}

    Iterator(const Iterator & iter):ConstIterator(iter)
    {}

    Iterator & operator=(const Iterator & iter)
    {
      this->ConstIterator::operator=(iter);
      return *this;
    }

protected:
    // To ensure const-correctness these method must not be in the public API.
    // The are purposly not implemented, since they should never be called.
    Iterator();
    Iterator(const Self *sample);
    Iterator(const ConstIterator & it);
    ConstIterator & operator=(const ConstIterator & it);

    // Only to be called from the MembershipSample
    Iterator(Self *memberSample,
             InstanceIdentifier iid):
      ConstIterator(memberSample, iid)
    {}

private:
  };

  Iterator Begin()
  {
    Iterator iter(this, 0);

    return iter;
  }

  Iterator  End()
  {
    Iterator iter( this, m_Sample->Size() );

    return iter;
  }

  ConstIterator Begin() const
  {
    ConstIterator iter(this,  0);

    return iter;
  }

  ConstIterator  End()  const
  {
    ConstIterator iter( this, m_Sample->Size() );

    return iter;
  }

protected:
  MembershipSample();
  ~MembershipSample() override = default;
  void PrintSelf(std::ostream & os, Indent indent) const override;

private:
  int GetInternalClassLabel(const ClassLabelType classLabel) const;

  UniqueClassLabelsType             m_UniqueClassLabels;
  ClassLabelHolderType              m_ClassLabelHolder;
  std::vector< ClassSamplePointer > m_ClassSamples;
  SampleConstPointer                m_Sample;
  unsigned int                      m_NumberOfClasses;
};  // end of class
} // end of namespace Statistics
} // end of namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkMembershipSample.hxx"
#endif

#endif