itkLabelContourImageFilter.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 itkLabelContourImageFilter_h
#define itkLabelContourImageFilter_h

#include "itkInPlaceImageFilter.h"
#include "itkImage.h"
#include "itkConceptChecking.h"
#include <vector>
#include "itkBarrier.h"

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

  itkNewMacro(Self);

  itkTypeMacro(LabelContourImageFilter, InPlaceImageFilter);

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

#ifdef ITK_USE_CONCEPT_CHECKING

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

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

  itkConceptMacro( SameDimension,
    ( Concept::SameDimension< itkGetStaticConstMacro(InputImageDimension),
                              itkGetStaticConstMacro(OutputImageDimension) > ) );

#endif

  typedef TInputImage                                 InputImageType;
  typedef typename InputImageType::Pointer            InputImagePointer;
  typedef typename InputImageType::IndexType          InputIndexType;
  typedef typename InputImageType::SizeType           InputSizeType;
  typedef typename InputImageType::OffsetType         InputOffsetType;
  typedef typename InputImageType::PixelType          InputImagePixelType;
  typedef typename InputImageType::SizeValueType      SizeValueType;
  typedef typename InputImageType::OffsetValueType    OffsetValueType;
  typedef typename InputImageType::PixelType          InputPixelType;

  typedef TOutputImage                          OutputImageType;
  typedef typename OutputImageType::Pointer     OutputImagePointer;
  typedef typename OutputImageType::RegionType  OutputRegionType;
  typedef typename OutputImageType::IndexType   OutputIndexType;
  typedef typename OutputImageType::SizeType    OutputSizeType;
  typedef typename OutputImageType::OffsetType  OutputOffsetType;
  typedef typename OutputImageType::PixelType   OutputImagePixelType;

  itkSetMacro(FullyConnected, bool);
  itkGetConstReferenceMacro(FullyConnected, bool);
  itkBooleanMacro(FullyConnected);

  itkSetMacro(BackgroundValue, OutputImagePixelType);
  itkGetConstMacro(BackgroundValue, OutputImagePixelType);

protected:

  LabelContourImageFilter();
  virtual ~LabelContourImageFilter() {}

  void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;

  void BeforeThreadedGenerateData() ITK_OVERRIDE;

  void AfterThreadedGenerateData() ITK_OVERRIDE;

  void ThreadedGenerateData(const OutputRegionType & outputRegionForThread,
                            ThreadIdType threadId) ITK_OVERRIDE;

  void GenerateInputRequestedRegion() ITK_OVERRIDE;

  void EnlargeOutputRequestedRegion( DataObject * itkNotUsed(output) ) ITK_OVERRIDE;

private:

  LabelContourImageFilter(const Self &);
  void operator = ( const Self& );

  struct RunLength
  {

    SizeValueType length;

    InputIndexType where;

    InputImagePixelType label;
  };

  typedef std::vector< RunLength >                  LineEncodingType;
  typedef typename LineEncodingType::iterator       LineEncodingIterator;
  typedef typename LineEncodingType::const_iterator LineEncodingConstIterator;

  typedef std::vector< OffsetValueType >            OffsetVectorType;
  typedef typename OffsetVectorType::const_iterator OffsetVectorConstIterator;

  // the map storing lines
  typedef std::vector< LineEncodingType > LineMapType;

  LineMapType           m_LineMap;
  OutputImagePixelType  m_BackgroundValue;
  ThreadIdType          m_NumberOfThreads;
  bool                  m_FullyConnected;

  bool CheckNeighbors(const OutputIndexType & A,
                      const OutputIndexType & B) const;

  void CompareLines(TOutputImage *output, LineEncodingType & current, const LineEncodingType & Neighbour);

  void SetupLineOffsets(OffsetVectorType & LineOffsets);

  void Wait();

  typename Barrier::Pointer m_Barrier;

};
} // end namespace itk

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

#endif