itkSample.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 itkSample_h
#define itkSample_h
 
#include "itkPoint.h"
#include "itkDataObject.h"
#include "itkMeasurementVectorTraits.h"
#include <vector> // for the size_type declaration
 
namespace itk
{
namespace Statistics
{
 
template <typename TMeasurementVector>
class Sample : public DataObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(Sample);

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

  itkOverrideGetNameOfClassMacro(Sample);

  using MeasurementVectorType = TMeasurementVector;

  using MeasurementType = typename MeasurementVectorTraitsTypes<MeasurementVectorType>::ValueType;

  using AbsoluteFrequencyType = MeasurementVectorTraits::AbsoluteFrequencyType;

  using TotalAbsoluteFrequencyType = NumericTraits<AbsoluteFrequencyType>::AccumulateType;

  using InstanceIdentifier = typename MeasurementVectorTraits::InstanceIdentifier;

  using MeasurementVectorSizeType = unsigned int;

  virtual InstanceIdentifier
  Size() const = 0;

  virtual const MeasurementVectorType &
  GetMeasurementVector(InstanceIdentifier id) const = 0;

  virtual AbsoluteFrequencyType
  GetFrequency(InstanceIdentifier id) const = 0;

  virtual TotalAbsoluteFrequencyType
  GetTotalFrequency() const = 0;

  virtual void
  SetMeasurementVectorSize(MeasurementVectorSizeType s)
  {
    // Test whether the vector type is resizable or not
    if (MeasurementVectorTraits::IsResizable<MeasurementVectorType>({}))
    {
      // then this is a resizable vector type
      //
      // if the new size is the same as the previous size, just return
      if (s == this->m_MeasurementVectorSize)
      {
        return;
      }
 
      // If the new size is different from the current size, then
      // only change the measurement vector size if the container is empty.
      if (this->Size())
      {
        itkExceptionMacro("Attempting to change the measurement vector size of a non-empty Sample");
      }
      else
      {
        this->m_MeasurementVectorSize = s;
        this->Modified();
      }
    }
    else
    {
      // If this is a non-resizable vector type
      const MeasurementVectorSizeType defaultLength = NumericTraits<MeasurementVectorType>::GetLength({});
      // and the new length is different from the default one, then throw an
      // exception
      if (defaultLength != s)
      {
        itkExceptionMacro("Attempting to change the measurement vector size of a non-resizable vector type");
      }
    }
  }

  itkGetConstMacro(MeasurementVectorSize, MeasurementVectorSizeType);

  void
  Graft(const DataObject * thatObject) override
  {
    this->Superclass::Graft(thatObject);
 
    const auto * thatConst = dynamic_cast<const Self *>(thatObject);
    if (thatConst)
    {
      this->SetMeasurementVectorSize(thatConst->GetMeasurementVectorSize());
    }
  }
 
protected:
  Sample() { m_MeasurementVectorSize = NumericTraits<MeasurementVectorType>::GetLength(MeasurementVectorType()); }
 
  ~Sample() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override
  {
    Superclass::PrintSelf(os, indent);
    os << indent << "Length of measurement vectors in the sample: " << m_MeasurementVectorSize << std::endl;
  }
 
private:
  MeasurementVectorSizeType m_MeasurementVectorSize{};
}; // end of class
} // end of namespace Statistics
} // end of namespace itk
 
#endif