mitkPythonContext.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkPythonContext_h
#define mitkPythonContext_h
 
#include <mitkImage.h>
#include <MitkPythonExports.h>
 
#include <memory>
#include <optional>
 
namespace mitk
{
  class MITKPYTHON_EXPORT PythonContext : public itk::LightObject
  {
  public:
    mitkClassMacroItkParent(PythonContext, itk::LightObject);
 
    itkFactorylessNewMacro(Self);
    mitkNewMacro1Param(Self, const std::string&);
 
    void Activate();
 
    bool HasVariable(const std::string &varName);
 
    template <typename T>
    std::optional<T> GetVariableAs(const std::string& varName);
 
    mitk::Image* LoadImageFromPython(const std::string &varName);
 
    void TransferBaseDataToPython(mitk::BaseData *mitkImage, const std::string &varName = "_mitk_image");
 
    std::string ExecuteString(const std::string &pyCommands);
 
    std::string ExecuteFile(const std::string &filePath);
 
    std::string GetPythonExceptionTraceback();
 
    std::string GetStdOut(const std::string &varName = "_mitk_stdout");
 
  protected:
    explicit PythonContext(const std::string& venvName = {});
    ~PythonContext();
 
  private:
    struct Impl;
    std::unique_ptr<Impl> m_Impl;
  };
 
  template <>
  MITKPYTHON_EXPORT std::optional<bool> PythonContext::GetVariableAs<bool>(const std::string&);
 
  template <>
  MITKPYTHON_EXPORT std::optional<int> PythonContext::GetVariableAs<int>(const std::string&);
 
  template <>
  MITKPYTHON_EXPORT std::optional<double> PythonContext::GetVariableAs<double>(const std::string&);
 
  template <>
  MITKPYTHON_EXPORT std::optional<std::string> PythonContext::GetVariableAs<std::string>(const std::string&);
}
 
#endif