summaryrefslogtreecommitdiffstats
path: root/python/astra/plugin.py
blob: ccdb2cbbbe7ad6e2e71613e1b31e970e39f6f968 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
#-----------------------------------------------------------------------
#Copyright 2013 Centrum Wiskunde & Informatica, Amsterdam
#
#Author: Daniel M. Pelt
#Contact: D.M.Pelt@cwi.nl
#Website: http://dmpelt.github.io/pyastratoolbox/
#
#
#This file is part of the Python interface to the
#All Scale Tomographic Reconstruction Antwerp Toolbox ("ASTRA Toolbox").
#
#The Python interface to the ASTRA Toolbox is free software: you can redistribute it and/or modify
#it under the terms of the GNU General Public License as published by
#the Free Software Foundation, either version 3 of the License, or
#(at your option) any later version.
#
#The Python interface to the ASTRA Toolbox is distributed in the hope that it will be useful,
#but WITHOUT ANY WARRANTY; without even the implied warranty of
#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
#GNU General Public License for more details.
#
#You should have received a copy of the GNU General Public License
#along with the Python interface to the ASTRA Toolbox. If not, see <http://www.gnu.org/licenses/>.
#
#-----------------------------------------------------------------------

from . import plugin_c as p
from . import log

class base(object):

    def astra_init(self, cfg):
        try:
            try:
                req = self.required_options
            except AttributeError:
                log.warn("Plugin '" + self.__class__.__name__ + "' does not specify required options")
                req = {}

            try:
                opt = self.optional_options
            except AttributeError:
                log.warn("Plugin '" + self.__class__.__name__ + "' does not specify optional options")
                opt = {}

            try:
                optDict = cfg['options']
            except KeyError:
                optDict = {}

            cfgKeys = set(optDict.keys())
            reqKeys = set(req)
            optKeys = set(opt)

            if not reqKeys.issubset(cfgKeys):
                for key in reqKeys.difference(cfgKeys):
                    log.error("Required option '" + key + "' for plugin '" + self.__class__.__name__ + "' not specified")
                raise ValueError("Missing required options")

            if not cfgKeys.issubset(reqKeys | optKeys):
                log.warn(self.__class__.__name__ + ": unused configuration option: " + str(list(cfgKeys.difference(reqKeys | optKeys))))

            self.initialize(cfg)
        except Exception as e:
            log.error(str(e))
            raise

def register(name, className):
    """Register plugin with ASTRA.
    
    :param name: Plugin name to register
    :type name: :class:`str`
    :param className: Class name or class object to register
    :type className: :class:`str` or :class:`class`
    
    """
    p.register(name,className)

def get_registered():
    """Get dictionary of registered plugins.
    
    :returns: :class:`dict` -- Registered plugins.
    
    """
    return p.get_registered()

def get_help(name):
    """Get help for registered plugin.
    
    :param name: Plugin name to get help for
    :type name: :class:`str`
    :returns: :class:`str` -- Help string (docstring).
    
    """
    return p.get_help(name)