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 "sitkIO.h"
#include "sitkProcessObject.h"
 
namespace itk::simple
{
 
class SITKIO_EXPORT ImageViewer
{
 
public:
  ImageViewer();
 
  virtual std::string GetName() const { return std::string("ImageViewer"); }
 
 
  static void SetGlobalDefaultSearchPath( const std::vector<std::string> & path );
  static const std::vector<std::string> & GetGlobalDefaultSearchPath();
  static void SetGlobalDefaultExecutableNames( const std::vector<std::string> & names );
  static const std::vector<std::string> & GetGlobalDefaultExecutableNames();
  static void SetGlobalDefaultFileExtension( const std::string & ext );
  static const std::string & GetGlobalDefaultFileExtension();
  static void SetGlobalDefaultApplication( const std::string & app );
  static const std::string & GetGlobalDefaultApplication();
  void SetApplication( const std::string & app, const std::string & command = "%a %f" );
 
  const std::string & 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:
 
  // hidden, no accessors
  static int  m_GlobalViewerImageCount;
  static bool m_GlobalAreDefaultsInitialized;
 
  // global only
  static std::vector<std::string> m_GlobalDefaultSearchPath;
  static std::vector<std::string> m_GlobalDefaultExecutableNames;
  static unsigned int             m_GlobalProcessDelay;
 
  static std::string m_GlobalDefaultViewCommand;
  static std::string m_GlobalDefaultFileExtension;
  static std::string m_GlobalDefaultApplication;
 
 
  static bool m_GlobalDefaultDebug;
 
  std::string m_ViewCommand;
  std::string m_CustomCommand;
 
  std::string m_Application;
 
  std::string m_FileExtension;
 
  std::string m_Title;
 
  static void initializeDefaults();
 
  static std::string FindViewingApplication();
};
 
}
#endif