otbObjectListToObjectListFilter.h

Go to the documentation of this file.

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

  Program:   ORFEO Toolbox
  Language:  C++
  Date:      $Date$
  Version:   $Revision$


  Copyright (c) Centre National d'Etudes Spatiales. All rights reserved.
  See OTBCopyright.txt for details.


     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __otbObjectListToObjectListFilter_h
#define __otbObjectListToObjectListFilter_h

#include "otbObjectListSource.h"

namespace otb
{

template <class TInputList, class TOutputList>
class ITK_EXPORT ObjectListToObjectListFilter : public otb::ObjectListSource<TOutputList>
{
public:
  typedef ObjectListToObjectListFilter       Self;
  typedef otb::ObjectListSource<TOutputList> Superclass;
  typedef itk::SmartPointer<Self>            Pointer;
  typedef itk::SmartPointer<const Self>      ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(ObjectListToObjectListFilter, ObjectListSource);

  typedef TInputList                          InputListType;
  typedef TOutputList                         OutputListType;
  typedef typename TInputList::ConstPointer   InputListPointer;
  typedef typename TOutputList::Pointer       OutputListPointer;
  typedef typename TInputList::ConstIterator  InputListIterator;
  typedef typename InputListType::ObjectType  InputObjectType;
  typedef typename OutputListType::ObjectType OutputObjectType;

  typedef itk::DataObject::Pointer DataObjectPointer;

  virtual void SetInput(const InputListType *input);
  const InputListType * GetInput(void);

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

  virtual void GenerateData(void);

  typedef std::vector<OutputListPointer> OutputListForThreadType;

  virtual void BeforeThreadedGenerateData();

  virtual void AfterThreadedGenerateData() {}

  virtual int SplitRequestedRegion(int threadId, int threadCount, unsigned int requestedElements,
                                   unsigned int& startIndex, unsigned int& stopIndex);

  virtual void ThreadedGenerateData(unsigned int startIndex, unsigned int stopIndex, int threadId);

  static ITK_THREAD_RETURN_TYPE ThreaderCallback(void *arg);

  struct ThreadStruct
  {
    Pointer Filter;
  };

  OutputListForThreadType m_ObjectListPerThread;

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

};

} // end namespace otb

#ifndef OTB_MANUAL_INSTANTIATION
#include "otbObjectListToObjectListFilter.txx"
#endif

#endif