otbMultiChannelExtractROI.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 otbMultiChannelExtractROI_h
#define otbMultiChannelExtractROI_h
 
#include "otbExtractROIBase.h"
#include "otbVectorImage.h"
#include "OTBImageBaseExport.h"
 
#include "itkMacro.h"
#include <vector>
 
namespace otb
{
 
template <class TInputPixelType, class TOutputPixelType>
class OTBImageBase_EXPORT_TEMPLATE MultiChannelExtractROI : public ExtractROIBase<VectorImage<TInputPixelType, 2>, VectorImage<TOutputPixelType, 2>>
{
public:
  typedef MultiChannelExtractROI Self;
  typedef ExtractROIBase<VectorImage<TInputPixelType, 2>, VectorImage<TOutputPixelType, 2>> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(MultiChannelExtractROI, ExtractROIBase);
 
  typedef typename Superclass::InputImageType  InputImageType;
  typedef typename Superclass::OutputImageType OutputImageType;
 
  typedef typename OutputImageType::InternalPixelType OutputValueType;
 
  typedef typename OutputImageType::RegionType OutputImageRegionType;
  typedef typename InputImageType::RegionType  InputImageRegionType;
 
  typedef typename OutputImageType::PixelType OutputImagePixelType;
  typedef typename InputImageType::PixelType  InputImagePixelType;
 
  typedef typename OutputImageType::IndexType OutputImageIndexType;
  typedef typename InputImageType::IndexType  InputImageIndexType;
  typedef typename OutputImageType::SizeType  OutputImageSizeType;
  typedef typename InputImageType::SizeType   InputImageSizeType;
 
  void SetFirstChannel(unsigned int id);
  itkGetConstMacro(FirstChannel, unsigned int);
  void SetLastChannel(unsigned int id);
  itkGetConstMacro(LastChannel, unsigned int);
 
  typedef typename std::vector<unsigned int> ChannelsType;
 
  ChannelsType GetChannels() const
  {
    return (m_Channels);
  }
 
  unsigned int GetNbChannels() const
  {
    return (m_Channels.size());
  }
 
  void SetChannel(unsigned int channel);
 
  void ClearChannels(void);
 
  itkStaticConstMacro(InputImageDimension, unsigned int, InputImageType::ImageDimension);
  itkStaticConstMacro(OutputImageDimension, unsigned int, OutputImageType::ImageDimension);
 
protected:
  MultiChannelExtractROI();
  ~MultiChannelExtractROI() override
  {
  }
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  void GenerateOutputInformation() override;
 
  void ChannelsReInitialization();
 
  void SetChannelsWorkWithLimits();
 
  void DynamicThreadedGenerateData(const OutputImageRegionType& outputRegionForThread) override;
 
private:
  MultiChannelExtractROI(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  unsigned int m_FirstChannel;
  unsigned int m_LastChannel;
 
  ChannelsType m_Channels;
 
  ChannelsType m_ChannelsWorks;
 
  int m_ChannelsKind;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbMultiChannelExtractROI.hxx"
#endif
 
#endif