text: /*=========================================================================
   *
   *  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 __itkCropImageFilter_h
  #define __itkCropImageFilter_h
  
  #include "itkExtractImageFilter.h"
  
  namespace itk
  {
  /** \class CropImageFilter
   * \brief Decrease the image size by cropping the image by an itk::Size at
   * both the upper and lower bounds of the largest possible region.
   *
   * CropImageFilter changes the image boundary of an image by removing
   * pixels outside the target region.  The target region is not specified in
   * advance, but calculated in BeforeThreadedGenerateData().
   *
   * This filter uses ExtractImageFilter to perform the cropping.
   *
   * \ingroup GeometricTransform
   * \ingroup ITKImageGrid
   *
   * \wiki
   * \wikiexample{ImageProcessing/CropImageFilter,Crop an image by specifying the region to throw away}
   * \endwiki
   */
  template< class TInputImage, class TOutputImage >
  class CropImageFilter:
    public ExtractImageFilter< TInputImage, TOutputImage >
  {
  public:
    /** Standard class typedefs. */
    typedef CropImageFilter                                 Self;
    typedef ExtractImageFilter< TInputImage, TOutputImage > Superclass;
    typedef SmartPointer< Self >                            Pointer;
    typedef SmartPointer< const Self >                      ConstPointer;
  
    /** Method for creation through the object factory. */
    itkNewMacro(Self);
  
    /** Run-time type information (and related methods). */
    itkTypeMacro(CropImageFilter, ExtractImageFilter);
  
    /** Typedef to describe the output and input image region types. */
    typedef typename Superclass::OutputImageRegionType OutputImageRegionType;
    typedef typename Superclass::InputImageRegionType  InputImageRegionType;
  
    /** Typedef to describe the type of pixel. */
    typedef typename Superclass::OutputImagePixelType OutputImagePixelType;
    typedef typename Superclass::InputImagePixelType  InputImagePixelType;
  
    /** Typedef to describe the output and input image index and size types. */
    typedef typename Superclass::OutputImageIndexType OutputImageIndexType;
    typedef typename Superclass::InputImageIndexType  InputImageIndexType;
    typedef typename Superclass::OutputImageSizeType  OutputImageSizeType;
    typedef typename Superclass::InputImageSizeType   InputImageSizeType;
    typedef InputImageSizeType                        SizeType;
  
    /** ImageDimension constants */
    itkStaticConstMacro(InputImageDimension, unsigned int,
                        Superclass::InputImageDimension);
    itkStaticConstMacro(OutputImageDimension, unsigned int,
                        Superclass::OutputImageDimension);
  
    /** Set/Get the cropping sizes for the upper and lower boundaries. */
    itkSetMacro(UpperBoundaryCropSize, SizeType);
    itkGetConstMacro(UpperBoundaryCropSize, SizeType);
    itkSetMacro(LowerBoundaryCropSize, SizeType);
    itkGetConstMacro(LowerBoundaryCropSize, SizeType);
  
    void SetBoundaryCropSize(const SizeType & s)
    {
      this->SetUpperBoundaryCropSize(s);
      this->SetLowerBoundaryCropSize(s);
    }
  
  #ifdef ITK_USE_CONCEPT_CHECKING
    /** Begin concept checking */
    itkConceptMacro( InputConvertibleToOutputCheck,
                     ( Concept::Convertible< InputImagePixelType, OutputImagePixelType > ) );
    itkConceptMacro( SameDimensionCheck,
                     ( Concept::SameDimension< InputImageDimension, OutputImageDimension > ) );
    /** End concept checking */
  #endif
  
  protected:
    CropImageFilter()
    {
      this->SetDirectionCollapseToSubmatrix();
      m_UpperBoundaryCropSize.Fill(0);
      m_LowerBoundaryCropSize.Fill(0);
    }
  
    ~CropImageFilter() {}
    void PrintSelf(std::ostream & os, Indent indent) const;
  
    void GenerateOutputInformation();
  
  private:
    CropImageFilter(const Self &); //purposely not implemented
    void operator=(const Self &);  //purposely not implemented
  
    SizeType m_UpperBoundaryCropSize;
    SizeType m_LowerBoundaryCropSize;
  };
  } // end namespace itk
  
  #ifndef ITK_MANUAL_INSTANTIATION
  #include "itkCropImageFilter.hxx"
  #endif
  
  #endif
  