itkExtractImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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 __itkExtractImageFilter_h
#define __itkExtractImageFilter_h

#include "itkInPlaceImageFilter.h"
#include "itkSmartPointer.h"
#include "itkExtractImageFilterRegionCopier.h"

namespace itk
{
template< class TInputImage, class TOutputImage >
class ITK_EXPORT ExtractImageFilter:
  public InPlaceImageFilter< TInputImage, TOutputImage >
{
public:
  typedef ExtractImageFilter                              Self;
  typedef InPlaceImageFilter< TInputImage, TOutputImage > Superclass;
  typedef SmartPointer< Self >                            Pointer;
  typedef SmartPointer< const Self >                      ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(ExtractImageFilter, ImageToImageFilter);

  typedef TInputImage  InputImageType;
  typedef TOutputImage OutputImageType;

  typedef typename TOutputImage::RegionType OutputImageRegionType;
  typedef typename TInputImage::RegionType  InputImageRegionType;

  typedef typename TOutputImage::PixelType OutputImagePixelType;
  typedef typename TInputImage::PixelType  InputImagePixelType;

  typedef typename TOutputImage::IndexType OutputImageIndexType;
  typedef typename TInputImage::IndexType  InputImageIndexType;
  typedef typename TOutputImage::SizeType  OutputImageSizeType;
  typedef typename TInputImage::SizeType   InputImageSizeType;

  typedef enum DirectionCollapseStrategyEnum {
    DIRECTIONCOLLAPSETOUNKOWN=0,
    DIRECTIONCOLLAPSETOIDENTITY=1,
    DIRECTIONCOLLAPSETOSUBMATRIX=2,
    DIRECTIONCOLLAPSETOGUESS=3
  } DIRECTIONCOLLAPSESTRATEGY;


  void SetDirectionCollapseToStrategy(const DIRECTIONCOLLAPSESTRATEGY choosenStrategy)
    {
    switch(choosenStrategy)
      {
    case DIRECTIONCOLLAPSETOGUESS:
    case DIRECTIONCOLLAPSETOIDENTITY:
    case DIRECTIONCOLLAPSETOSUBMATRIX:
      break;
    case DIRECTIONCOLLAPSETOUNKOWN:
    default:
      itkExceptionMacro( << "Invalid Strategy Chosen for itk::ExtractImageFilter" );
      }

    this->m_DirectionCollapseStrategy=choosenStrategy;
    this->Modified();
    }

  DIRECTIONCOLLAPSESTRATEGY GetDirectionCollapseToStrategy() const
    {
    return this->m_DirectionCollapseStrategy;
    }

  void SetDirectionCollapseToGuess()
    {
    this->SetDirectionCollapseToStrategy(DIRECTIONCOLLAPSETOGUESS);
    }

  void SetDirectionCollapseToIdentity()
    {
    this->SetDirectionCollapseToStrategy(DIRECTIONCOLLAPSETOIDENTITY);
    }

  void SetDirectionCollapseToSubmatrix()
    {
    this->SetDirectionCollapseToStrategy(DIRECTIONCOLLAPSETOSUBMATRIX);
    }


  itkStaticConstMacro(InputImageDimension, unsigned int,
                      TInputImage::ImageDimension);
  itkStaticConstMacro(OutputImageDimension, unsigned int,
                      TOutputImage::ImageDimension);

  typedef ImageToImageFilterDetail::ExtractImageFilterRegionCopier<
    itkGetStaticConstMacro(InputImageDimension),
    itkGetStaticConstMacro(OutputImageDimension) > ExtractImageFilterRegionCopierType;

  void SetExtractionRegion(InputImageRegionType extractRegion);
  itkGetConstMacro(ExtractionRegion, InputImageRegionType);

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro( InputCovertibleToOutputCheck,
                   ( Concept::Convertible< InputImagePixelType, OutputImagePixelType > ) );

#endif
protected:
  ExtractImageFilter();
  ~ExtractImageFilter() {}
  void PrintSelf(std::ostream & os, Indent indent) const;

  virtual void GenerateOutputInformation();

  virtual void CallCopyOutputRegionToInputRegion(InputImageRegionType & destRegion,
                                                 const OutputImageRegionType & srcRegion);

  void ThreadedGenerateData(const OutputImageRegionType & outputRegionForThread,
                            ThreadIdType threadId);

  void GenerateData();

  InputImageRegionType m_ExtractionRegion;

  OutputImageRegionType m_OutputImageRegion;
private:
  ExtractImageFilter(const Self &); //purposely not implemented
  void operator=(const Self &);     //purposely not implemented

  DIRECTIONCOLLAPSESTRATEGY m_DirectionCollapseStrategy;
};
} // end namespace itk

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

#endif