QuickView.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 QuickView_h
#define QuickView_h
 
#include <vector>
#include <algorithm>
#include <string>
 
#include <itkImage.h>
#include <itkRGBPixel.h>
#include <itkIntTypes.h>
 
#include "ITKVtkGlueExport.h"
 
class ITKVtkGlue_EXPORT ImageInfo
{
public:
  using ImageType = itk::Image<unsigned char, 2>;
 
  ImageInfo(ImageType * image, std::string description = "")
  {
    m_Image = image;
    m_Description = description;
  }
 
  ImageType::Pointer m_Image;
  std::string        m_Description;
};
 
class ITKVtkGlue_EXPORT RGBImageInfo
{
public:
  using ImageType = itk::Image<itk::RGBPixel<unsigned char>, 2>;
  RGBImageInfo(ImageType * image, std::string description = "")
  {
    m_Image = image;
    m_Description = description;
  }
 
  ImageType::Pointer m_Image;
  std::string        m_Description;
};
 
    viewer.AddRGBImage(someFilter->GetOutput().
                       true (to flip image) or false.
                       "text to display with the image");
    \endcode
 *
 * \ingroup ITKVtkGlue
 */
class ITKVtkGlue_EXPORT QuickView
{
public:
  QuickView()
  {
    m_ShareCamera = true;
    m_Interpolate = true;
    m_Counter = 0;
    m_Snapshot = false;
    m_SnapshotPath = "";
    m_SnapshotPrefix = "snapshot_";
    m_SnapshotExtension = "png";
    m_NumberOfColumns = 4;
    m_ViewPortSize = 300;
  }
  template <typename TImage>
  void
  AddImage(TImage *, bool FlipVertical = true, std::string Description = "");
 
  template <typename TImage>
  void
  AddRGBImage(TImage *, bool FlipVertical = true, std::string Description = "");
 
  void
  Visualize(bool interact = true);
 
 
  void
  ShareCameraOff()
  {
    m_ShareCamera = false;
  }
 
  void
  ShareCameraOn()
  {
    m_ShareCamera = true;
  }
 
  void
  InterpolateOff()
  {
    m_Interpolate = false;
  }
 
  void
  InterpolateOn()
  {
    m_Interpolate = true;
  }
 
  void
  SnapshotOn()
  {
    m_Snapshot = true;
  }
 
  void
  SnapshotOff()
  {
    m_Snapshot = false;
  }
 
  void
  SetSnapshotPath(const std::string & iPath)
  {
    m_SnapshotPath = iPath;
  }
 
  void
  SetSnapshotPrefix(const std::string & iPrefix)
  {
    m_SnapshotPrefix = iPrefix;
  }
 
  void
  SetSnapshotExtension(const std::string & iExtension)
  {
    m_SnapshotExtension = iExtension;
    std::transform(m_SnapshotExtension.begin(), m_SnapshotExtension.end(), m_SnapshotExtension.begin(), ::tolower);
  }
  void
  SetNumberOfColumns(const unsigned int columns)
  {
    m_NumberOfColumns = columns;
  }
 
  void
  SetViewPortSize(const unsigned int size)
  {
    m_ViewPortSize = size;
  }
 
private:
  std::vector<ImageInfo>    Images;    // Container for images
  std::vector<RGBImageInfo> RGBImages; // Container for rgb images
  itk::IdentifierType       m_Counter;
  std::string               m_SnapshotPath;
  std::string               m_SnapshotPrefix;
  std::string               m_SnapshotExtension;
  bool                      m_ShareCamera;
  bool                      m_Snapshot;
  bool                      m_Interpolate;
  unsigned int              m_NumberOfColumns;
  unsigned int              m_ViewPortSize;
};
 
#endif