itkListSampleCArray.h

Go to the documentation of this file.

/*======================================================================

  This file is part of the elastix software.

  Copyright (c) University Medical Center Utrecht. All rights reserved.
  See src/CopyrightElastix.txt or http://elastix.isi.uu.nl/legal.php for
  details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE. See the above copyright notices for more information.

======================================================================*/
#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 ListSampleCArray :
  public Sample< TMeasurementVector >
{
public:

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

  itkNewMacro( Self );

  itkTypeMacro( ListSampleCArray, Sample );

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

  typedef TInternalValue      InternalValueType;
  typedef InternalValueType * InternalDataType;
  typedef InternalDataType *  InternalDataContainerType;

  itkGetConstMacro( InternalContainer, InternalDataContainerType );

  void Resize( unsigned long n );

  void SetActualSize( unsigned long n );

  unsigned long GetActualSize( void );

  void Clear( void );

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


  virtual const MeasurementVectorType & GetMeasurementVector(
    InstanceIdentifier id ) const;

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

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

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

  virtual AbsoluteFrequencyType GetFrequency( InstanceIdentifier id ) const;

  virtual TotalAbsoluteFrequencyType GetTotalFrequency( void ) const
  {
    return static_cast< TotalAbsoluteFrequencyType >( this->m_InternalContainerSize );
  }


protected:

  ListSampleCArray();
  virtual ~ListSampleCArray();
  void PrintSelf( std::ostream & os, Indent indent ) const;

private:

  ListSampleCArray( const Self & );   // purposely not implemented
  void operator=( const Self & );     // purposely not implemented

  InternalDataContainerType m_InternalContainer;
  InstanceIdentifier        m_InternalContainerSize;
  InstanceIdentifier        m_ActualSize;

  mutable MeasurementVectorType m_TemporaryMeasurementVector;

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

  void DeallocateInternalContainer( void );

};

} // end namespace Statistics
} // end namespace itk

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

#endif // end #ifndef __itkListSampleCArray_h