sitkImageViewer.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
 *
 *         http://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 sitkImageViewer_h
#define sitkImageViewer_h
 
#include "sitkImage.h"
#include "sitkPathType.h"
#include "sitkIO.h"
#include "sitkProcessObject.h"
 
namespace itk::simple
{

class SITKIO_EXPORT ImageViewer
{
 
public:
  ImageViewer();
  virtual ~ImageViewer() = default;

  virtual std::string
  GetName() const
  {
    return std::string("ImageViewer");
  }
 

  static void
  SetGlobalDefaultSearchPath(const std::vector<PathType> & path);
  static const std::vector<PathType> &
  GetGlobalDefaultSearchPath();

  static void
  SetGlobalDefaultExecutableNames(const std::vector<PathType> & names);
  static const std::vector<PathType> &
  GetGlobalDefaultExecutableNames();

  static void
  SetGlobalDefaultFileExtension(const std::string & ext);
  static const std::string &
  GetGlobalDefaultFileExtension();

  static void
  SetGlobalDefaultApplication(const PathType & app);
  static const PathType &
  GetGlobalDefaultApplication();

  void
  SetApplication(const PathType & app, const std::string & command = "%a %f");

  const PathType &
  GetApplication() const;

  void
  SetCommand(const std::string & command);
 
  /* \brief Get the command string used to launch the viewing application */
  const std::string &
  GetCommand() const;

  void
  SetFileExtension(const std::string & ext);
  const std::string &
  GetFileExtension() const;

  static void
  SetGlobalDefaultDebug(const bool dbg);
  static bool
  GetGlobalDefaultDebug();
 
  static void
  SetGlobalDefaultDebugOn();
  static void
  SetGlobalDefaultDebugOff();

  static void
  SetProcessDelay(const unsigned int delay);
  static unsigned int
  GetProcessDelay();

  void
  SetTitle(const std::string & t);
  const std::string &
  GetTitle() const;

  void
  Execute(const Image & image);

  std::string
  ToString() const;
 
 
private:
  std::string m_ViewCommand;
  std::string m_CustomCommand;
 
  PathType m_Application;
 
  std::string m_FileExtension;
 
  std::string m_Title;
};
 
} // namespace itk::simple
#endif