itkImageToListGenerator.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkImageToListGenerator.h,v $
  Language:  C++
  Date:      $Date: 2007-04-25 22:25:16 $
  Version:   $Revision: 1.3 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm 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 __itkImageToListGenerator_h
#define __itkImageToListGenerator_h

#include "itkListSample.h"
#include "itkPixelTraits.h"
#include "itkProcessObject.h"
#include "itkDataObject.h"
#include "itkDataObjectDecorator.h"
#include "itkFixedArray.h"

namespace itk { 
namespace Statistics {

template < class TImage, class TMaskImage = TImage > 
class ITK_EXPORT ImageToListGenerator :
  public ProcessObject
{
public:
  typedef ImageToListGenerator        Self;
  typedef ProcessObject               Superclass;
  typedef SmartPointer< Self >        Pointer;
  typedef SmartPointer<const Self>    ConstPointer;

  itkTypeMacro(ImageToListGenerator, ProcessObject);

  itkNewMacro(Self);

  typedef TImage                           ImageType;
  typedef typename ImageType::Pointer      ImagePointer;
  typedef typename ImageType::ConstPointer ImageConstPointer;
  typedef typename ImageType::PixelType    PixelType;
  typedef FixedArray< PixelType, 1 >       MeasurementVectorType;

  typedef TMaskImage                           MaskImageType;
  typedef typename MaskImageType::Pointer      MaskImagePointer;
  typedef typename MaskImageType::ConstPointer MaskImageConstPointer;
  typedef typename MaskImageType::PixelType    MaskPixelType;

  typedef ListSample< MeasurementVectorType >  ListSampleType;

  typedef PixelTraits< typename ImageType::PixelType > PixelTraitsType;
  typedef typename ListSampleType::MeasurementVectorSizeType 
                                     MeasurementVectorSizeType;

  typedef DataObject::Pointer DataObjectPointer;

  typedef DataObjectDecorator< ListSampleType >  ListSampleOutputType;

  itkStaticConstMacro(MeasurementVectorSize, unsigned int,
                      PixelTraitsType::Dimension);

  virtual DataObjectPointer MakeOutput(unsigned int idx);

  virtual void SetMeasurementVectorSize( const MeasurementVectorSizeType s )
    {
    // Measurement vector size for this class is fixed as the pixel's 
    // dimension. This method should throw an exception if the user tries to 
    // set the dimension to a different value. 
    if( s != MeasurementVectorSize )
      {
      itkExceptionMacro(
        << "Measurement vector size for the image adaptor obtained"
        << " from the pixel dimension is: "
        << MeasurementVectorSize << " but you "
        << "are setting it to " << s);
      }
    }

  unsigned int GetMeasurementVectorSize() const 
    {
    return MeasurementVectorSize;
    } 

  void SetInput( const ImageType* image );
  const ImageType* GetInput() const;

  void SetMaskImage( const MaskImageType* image );
  const MaskImageType* GetMaskImage() const;

  const ListSampleType * GetListSample() const;

  itkSetMacro( MaskValue, MaskPixelType );
  itkGetMacro( MaskValue, MaskPixelType );

  virtual void GenerateData();

  virtual void GenerateInputRequestedRegion()
    throw(InvalidRequestedRegionError);

  virtual void GenerateOutputInformation();

protected:
  ImageToListGenerator();
  virtual ~ImageToListGenerator() {}
  void PrintSelf(std::ostream& os, Indent indent) const;  

private:
  ImageToListGenerator(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  MaskPixelType m_MaskValue;

}; // end of class ImageToListGenerator

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

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkImageToListGenerator.txx"
#endif

#endif