otbObjectListToObjectListFilter.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * 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
 *
 * 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 otbObjectListToObjectListFilter_h
#define otbObjectListToObjectListFilter_h
 
#include "otbObjectListSource.h"
#include "otbMacro.h" //for ITK_THREAD_RETURN_TYPE in ITK5
#include "itkMultiThreaderBase.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;
 
  using Superclass::SetInput;
  virtual void SetInput(const InputListType* input);
  const InputListType* GetInput(void);
 
protected:
  ObjectListToObjectListFilter();
 
  ~ObjectListToObjectListFilter() override
  {
  }
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  void GenerateData(void) override;
 
  typedef std::vector<OutputListPointer> OutputListForThreadType;
 
  virtual void BeforeThreadedGenerateData();
 
  virtual void AfterThreadedGenerateData()
  {
  }
 
  virtual int SplitRequestedRegion(itk::ThreadIdType threadId, int threadCount, unsigned int requestedElements, unsigned int& startIndex,
                                   unsigned int& stopIndex);
 
  virtual void ThreadedGenerateData(unsigned int startIndex, unsigned int stopIndex, itk::ThreadIdType threadId);
 
  static itk::ITK_THREAD_RETURN_TYPE ThreaderCallback(void *arg);
 
  struct ThreadStruct
  {
    Pointer Filter;
  };
 
  OutputListForThreadType m_ObjectListPerThread;
 
private:
  ObjectListToObjectListFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbObjectListToObjectListFilter.hxx"
#endif
 
#endif