US/USHardwareDiPhAS/ITKUltrasound/itkRegionFromReferenceImageFilter.h

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE 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 itkRegionFromReferenceImageFilter_h
#define itkRegionFromReferenceImageFilter_h

#include "itkExtractImageFilter.h"

namespace itk
{

template< typename TInputImage, typename TOutputImage=TInputImage >
class RegionFromReferenceImageFilter:
    public ExtractImageFilter<TInputImage,TOutputImage>
{
public:
  typedef RegionFromReferenceImageFilter               Self;
  typedef ExtractImageFilter<TInputImage,TOutputImage> Superclass;
  typedef SmartPointer<Self>                           Pointer;
  typedef SmartPointer<const Self>                     ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(RegionFromReferenceImageFilter, ExtractImageFilter);

  typedef typename Superclass::OutputImageRegionType OutputImageRegionType;
  typedef typename Superclass::InputImageRegionType  InputImageRegionType;

  typedef typename Superclass::OutputImagePixelType OutputImagePixelType;
  typedef typename Superclass::InputImagePixelType  InputImagePixelType;

  typedef typename Superclass::OutputImageIndexType OutputImageIndexType;
  typedef typename Superclass::InputImageIndexType  InputImageIndexType;
  typedef typename Superclass::OutputImageSizeType  OutputImageSizeType;
  typedef typename Superclass::InputImageSizeType   InputImageSizeType;
  typedef InputImageSizeType                        SizeType;

  itkStaticConstMacro(InputImageDimension, unsigned int,
                      Superclass::InputImageDimension);
  itkStaticConstMacro(OutputImageDimension, unsigned int,
                      Superclass::OutputImageDimension);
  itkStaticConstMacro(ImageDimension, unsigned int,
                      Superclass::OutputImageDimension);

  typedef ImageBase< itkGetStaticConstMacro( ImageDimension ) >    ReferenceImageType;

  void SetReferenceImage ( const ReferenceImageType *image );

  const ReferenceImageType * GetReferenceImage() const;

  void SetInput1(const TInputImage *input)
    {
    this->SetInput( input );
    }

  void SetInput2(const ReferenceImageType *input)
    {
    this->SetReferenceImage( input );
    }


#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(InputConvertibleToOutputCheck,
    (Concept::Convertible<InputImagePixelType, OutputImagePixelType>));
  itkConceptMacro(SameDimensionCheck,
    (Concept::SameDimension<InputImageDimension, OutputImageDimension>));
#endif

protected:
  RegionFromReferenceImageFilter()
    {
    this->SetNumberOfRequiredInputs(2);
    }
  ~RegionFromReferenceImageFilter() {}

  virtual void GenerateOutputInformation() ITK_OVERRIDE;

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

} // end namespace itk

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

#endif