itkListSampleCArray.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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 itkListSampleCArray_h
#define itkListSampleCArray_h
 
#include "itkObjectFactory.h"
//#include "itkListSampleBase.h"
#include "itkSample.h"
 
namespace itk
{
namespace Statistics
{

 
template <class TMeasurementVector, class TInternalValue = typename TMeasurementVector::ValueType>
class ITK_TEMPLATE_EXPORT ListSampleCArray : public Sample<TMeasurementVector>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ListSampleCArray);

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

  itkNewMacro(Self);

  itkTypeMacro(ListSampleCArray, Sample);

  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 InternalValueType = TInternalValue;
  using InternalDataType = InternalValueType *;
  using InternalDataContainerType = InternalDataType *;

  itkGetConstMacro(InternalContainer, InternalDataContainerType);

  void
  Resize(unsigned long n);

  void
  SetActualSize(unsigned long n);

  unsigned long
  GetActualSize();

  void
  Clear();

  InstanceIdentifier
  Size() const override
  {
    return this->m_InternalContainerSize;
  }
 

  const MeasurementVectorType &
  GetMeasurementVector(InstanceIdentifier id) const override;

  void
  GetMeasurementVector(InstanceIdentifier id, MeasurementVectorType & mv) const;

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

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

  AbsoluteFrequencyType
  GetFrequency(InstanceIdentifier id) const override;

  TotalAbsoluteFrequencyType
  GetTotalFrequency() const override
  {
    return static_cast<TotalAbsoluteFrequencyType>(this->m_InternalContainerSize);
  }
 
 
protected:
  ListSampleCArray();
  ~ListSampleCArray() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  InternalDataContainerType m_InternalContainer{};
  InstanceIdentifier        m_InternalContainerSize{};
  InstanceIdentifier        m_ActualSize{};

  mutable MeasurementVectorType m_TemporaryMeasurementVector{};

  void
  AllocateInternalContainer(unsigned long size, unsigned int dim);

  void
  DeallocateInternalContainer();
};
 
} // end namespace Statistics
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkListSampleCArray.hxx"
#endif
 
#endif // end #ifndef itkListSampleCArray_h