itkPermuteAxesImageFilter.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 __itkPermuteAxesImageFilter_h
#define __itkPermuteAxesImageFilter_h

#include "itkImageToImageFilter.h"
#include "itkFixedArray.h"

namespace itk
{
template< typename TImage >
class PermuteAxesImageFilter:
  public ImageToImageFilter< TImage, TImage >
{
public:
  typedef PermuteAxesImageFilter               Self;
  typedef ImageToImageFilter< TImage, TImage > Superclass;
  typedef SmartPointer< Self >                 Pointer;
  typedef SmartPointer< const Self >           ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(PermuteAxesImageFilter, ImageToImageFilter);

  itkStaticConstMacro(ImageDimension, unsigned int,
                      TImage::ImageDimension);

  typedef typename Superclass::InputImagePointer     InputImagePointer;
  typedef typename Superclass::OutputImagePointer    OutputImagePointer;
  typedef typename Superclass::OutputImageRegionType OutputImageRegionType;

  typedef FixedArray< unsigned int, itkGetStaticConstMacro(ImageDimension) > PermuteOrderArrayType;

  void SetOrder(const PermuteOrderArrayType & order);

  itkGetConstReferenceMacro(Order, PermuteOrderArrayType);

  itkGetConstReferenceMacro(InverseOrder, PermuteOrderArrayType);

  virtual void GenerateOutputInformation();

  virtual void GenerateInputRequestedRegion();

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

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

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

  PermuteOrderArrayType m_Order;
  PermuteOrderArrayType m_InverseOrder;
};
} // end namespace itk

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

#endif