otbImageLayerRenderingModel.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 __otbImageLayerRenderingModel_h
#define __otbImageLayerRenderingModel_h

#include "otbMVCModel.h"
#include "otbLayerBasedModel.h"
#include "otbImageLayerBase.h"
#include "otbObjectList.h"
#include "otbImageLayerRenderingModelListener.h"
#include "otbBlendingImageFilter.h"
#include "otbListenerBase.h"

namespace otb
{
template <class TOutputImage,
    class TLayer = otb::ImageLayerBase<TOutputImage> >
class ImageLayerRenderingModel
  : public MVCModel<ListenerBase>, public LayerBasedModel<TLayer>
{
public:
  typedef ImageLayerRenderingModel      Self;
  typedef LayerBasedModel<TLayer>       Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;

  itkTypeMacro(ImageLayerRenderingModel, LayerBasedModel);

  itkNewMacro(Self);

  typedef TOutputImage                      OutputImageType;
  typedef typename OutputImageType::Pointer OutputImagePointerType;

  typedef typename Superclass::LayerType LayerType;
  typedef typename LayerType::RegionType RegionType;
  typedef typename RegionType::IndexType IndexType;
  typedef typename RegionType::SizeType  SizeType;

  typedef typename Superclass::LayerListType    LayerListType;
  typedef typename LayerListType::Pointer       LayerListPointerType;
  typedef typename LayerListType::ConstIterator LayerIteratorType;

  typedef ListenerBase ListenerType;

  typedef otb::BlendingImageFilter<OutputImageType> BlendingFilterType;

  typedef otb::ObjectList<BlendingFilterType>       BlendingFilterListType;
  typedef typename BlendingFilterListType::Pointer  BlendingFilterListPointerType;
  typedef typename BlendingFilterListType::Iterator BlendingFilterIteratorType;

  itkGetStringMacro(Name);
  itkSetStringMacro(Name);

  itkGetObjectMacro(RasterizedQuicklook, OutputImageType);
  itkGetObjectMacro(RasterizedExtract, OutputImageType);
  itkGetObjectMacro(RasterizedScaledExtract, OutputImageType);

  itkSetMacro(ExtractRegion, RegionType);
  itkGetConstReferenceMacro(ExtractRegion, RegionType);

  itkSetMacro(ScaledExtractRegion, RegionType);
  itkGetConstReferenceMacro(ScaledExtractRegion, RegionType);

  itkGetMacro(HasQuicklook, bool);
  itkGetMacro(HasExtract, bool);
  itkGetMacro(HasScaledExtract, bool);

  virtual void Update(void);

  virtual void SetScaledExtractRegionCenter(const IndexType& index);

  virtual void SetExtractRegionCenter(const IndexType& index);

  virtual void SetExtractRegionByIndex(const IndexType& startIndex, const IndexType& stopIndex);

  virtual unsigned int GetSubsamplingRate();

  virtual void Init();

protected:
  ImageLayerRenderingModel();
  virtual ~ImageLayerRenderingModel();

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

  virtual void         RenderVisibleLayers(void);

  virtual void         RasterizeVisibleLayers(void);

  virtual void         NotifyListener(ListenerType * listener);

  virtual RegionType    ConstrainRegion(const RegionType& region, const RegionType& largest);

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

  std::string m_Name;

  OutputImagePointerType m_RasterizedQuicklook;
  bool                   m_HasQuicklook;

  OutputImagePointerType m_RasterizedExtract;
  bool                   m_HasExtract;
  RegionType             m_ExtractRegion;

  OutputImagePointerType m_RasterizedScaledExtract;
  bool                   m_HasScaledExtract;
  RegionType             m_ScaledExtractRegion;

  bool m_Updating;

  BlendingFilterListPointerType m_QuicklookBlendingFilterList;
  BlendingFilterListPointerType m_ExtractBlendingFilterList;
  BlendingFilterListPointerType m_ScaledExtractBlendingFilterList;

}; // end class
} // end namespace otb

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

#endif