itkImageToListSampleFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkImageToListSampleFilter.h,v $
  Language:  C++
  Date:      $Date: 2009-05-02 05:43:56 $
  Version:   $Revision: 1.1 $

  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 __itkImageToListSampleFilter_h
#define __itkImageToListSampleFilter_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 ImageToListSampleFilter :
  public ProcessObject
{
public:
  typedef ImageToListSampleFilter     Self;
  typedef ProcessObject               Superclass;
  typedef SmartPointer< Self >        Pointer;
  typedef SmartPointer<const Self>    ConstPointer;

  itkTypeMacro(ImageToListSampleFilter, ProcessObject);

  itkNewMacro(Self);

  typedef TImage                           ImageType;
  typedef typename ImageType::Pointer      ImagePointer;
  typedef typename ImageType::ConstPointer ImageConstPointer;
  typedef typename ImageType::PixelType    PixelType;
  typedef typename MeasurementVectorPixelTraits< 
    PixelType >::MeasurementVectorType     MeasurementVectorType;

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

  typedef ListSample< MeasurementVectorType >  ListSampleType;

  unsigned int GetMeasurementVectorSize() const;

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

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

  const ListSampleType * GetOutput() const;

  itkSetMacro( MaskValue, MaskPixelType );
  itkGetConstMacro( MaskValue, MaskPixelType );

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

  typedef DataObject::Pointer DataObjectPointer;
  virtual DataObjectPointer MakeOutput(unsigned int idx);

  virtual void GenerateData();

  virtual void GenerateInputRequestedRegion()
    throw(InvalidRequestedRegionError);

  virtual void GenerateOutputInformation();

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

  MaskPixelType m_MaskValue;

}; // end of class ImageToListSampleFilter

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

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

#endif