configuration.py 10.5 KB
Newer Older
1
# -*- coding: utf-8 -*-
2
3
# Copyright (C) 2012, 2013 Centre de données Astrophysiques de Marseille
# Licensed under the CeCILL-v2 licence - see Licence_CeCILL_V2-en.txt
Yannick Roehlly's avatar
Yannick Roehlly committed
4
# Author: Yannick Roehlly
5
6
7
8

import configobj
import pkg_resources
import pkgutil
9
import collections
10
import itertools
11
import numpy as np
12
from glob import glob # To allow the use of glob() in "eval..."
13
from textwrap import wrap
14
from .tools import param_dict_combine
15
from ..data import Database
16
from ..utils import read_table
17
18
from .. import creation_modules
from .. import analysis_modules
19
20
21
22
23


def list_modules(package_name):
    """Lists the modules available in a package

Yannick Roehlly's avatar
Yannick Roehlly committed
24
    Parameters
25
26
    ----------
    package_name : string
27
        Name of the package (e.g. pcigale.creation_modules).
28
29
30
31
32
33
34
35
36
37
38
39
40

    Returns
    -------
    module_name : array of strings
        List of the available modules.

    """
    directory = pkg_resources.resource_filename(package_name, '')
    module_names = [name for _, name, _ in pkgutil.iter_modules([directory])]

    return module_names


Yannick Roehlly's avatar
Yannick Roehlly committed
41
42
43
44
45
46
def evaluate_description(description):
    """Evaluate a description from the config file as a list.

    The description is read from the config file by configobj that transforms
    coma separated value in a list. From this description, this function try
    to evaluate the desired list of values:
47
48
49
    - If the description is a string beginning with 'eval ', then its content
      (without 'eval ') is evaluated as Python code and its result returned.
      An array is expected.
50
51
52
    - If the description is a string beginning by 'range', the start, step and
      stop values are then expected and the range is evaluated (stop included
      if reached.
Yannick Roehlly's avatar
Yannick Roehlly committed
53
54
    - Then the function tries to evaluate the description as a Numpy array of
      float and returns the mere list if this fails.
55

Yannick Roehlly's avatar
Yannick Roehlly committed
56
    Parameters
57
    ----------
Yannick Roehlly's avatar
Yannick Roehlly committed
58
    description : string or list
59
60
61
62
        The description to be evaluated.

    Returns
    -------
63
     results : list
Yannick Roehlly's avatar
Yannick Roehlly committed
64
        The evaluated list of values.
65
66

    """
67
68
69
70
71
72
73
74
75
76
77
78
79
80
    results = description
    if type(description) == str:
        if description.startswith('eval '):
            results = eval(description[4:])
            # If the evaluation lead to a single value, we put it in a list.
            if not isinstance(results, collections.Iterable):
                results = [results]
        elif description.startswith('range '):
            start, stop, step = [float(item) for item
                                 in description[5:].split()]
            results = np.arange(start, stop+step, step)
        else:
            # We need to return a list to combine the list of possible values
            # for each parameter.
81
            results = [results]
82
83
84
85
86
87
88

    # We prefer to evaluate the parameter as a numpy array of floats if
    # possible.
    try:
        results = np.array(results, float)
    except ValueError:
        pass
89

Yannick Roehlly's avatar
Yannick Roehlly committed
90
    return results
91
92
93
94
95
96
97
98
99


class Configuration(object):
    """This class manages the configuration of pcigale.
    """

    def __init__(self, filename="pcigale.ini"):
        """Initialise a pcigale configuration.

Yannick Roehlly's avatar
Yannick Roehlly committed
100
        Parameters
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
        ----------
        filename : string
            Name of the configuration file (pcigale.conf by default).

        """
        self.config = configobj.ConfigObj(filename,
                                          write_empty_values=True,
                                          indent_type='  ')

    def create_blank_conf(self):
        """Create the initial configuration file

        Write the initial pcigale configuration file where the user can state
        which data file to use, which modules to use for the SED creation, as
        well as the method selected for statistical analysis.

        """

        self.config['data_file'] = ""
        self.config.comments['data_file'] = wrap(
            "File containing the observation data to be fitted. Each flux "
            "column must have the name of the corresponding filter, the "
            "error columns are suffixed with '_err'. The values must be "
            "in mJy.")

126
127
        self.config['creation_modules'] = []
        self.config.comments['creation_modules'] = [""] + wrap(
128
            "Order of the modules use for SED creation. Available modules : "
129
            + ', '.join(list_modules('pcigale.creation_modules')) + ".")
130
131
132
133

        self.config['analysis_method'] = ""
        self.config.comments['analysis_method'] = [""] + wrap(
            "Method used for statistical analysis. Available methods: "
134
            + ', '.join(list_modules('pcigale.analysis_modules')) + ".")
135
136
137
138
139
140
141
142
143
144
145
146
147

        self.config.write()

    def generate_conf(self):
        """Generate the full configuration file

        Reads the user entries in the initial configuration file and add the
        configuration options of all selected modules as well as the filter
        selection based on the filters identified in the data table file.

        """

        # Getting the list of the filters available in pcigale database
148
149
        with Database() as base:
            filter_list = base.get_filter_list()[0]
150
151

        # Finding the known filters in the data table
152
        obs_table = read_table(self.config['data_file'])
153
154
155
156
157
158
159
160
161
        column_list = []
        for column in obs_table.columns:
            filter_name = column[:-4] if column.endswith('_err') else column
            if filter_name in filter_list:
                column_list.append(column)

        # Check that we don't have an error column without the associated flux
        for column in column_list:
            if column.endswith('_err') and (column[:-4] not in column_list):
162
                raise Exception("The observation table as a {} column "
Médéric Boquien's avatar
Médéric Boquien committed
163
164
                                "but no {} column.".format(column,
                                                           column[:-4]))
165
166
167
168
169
170
171

        self.config['column_list'] = column_list
        self.config.comments['column_list'] = [""] + wrap(
            "List of the columns in the observation data file to use for "
            "the fitting.")

        # SED creation modules configurations. For each module, we generate
Yannick Roehlly's avatar
Yannick Roehlly committed
172
        # the configuration section from its parameter list.
173
174
175
176
        self.config['sed_creation_modules'] = {}
        self.config.comments['sed_creation_modules'] = ["", ""] + wrap(
            "Configuration of the SED creation modules.")

177
        for module_name in self.config['creation_modules']:
178
179
180
            self.config["sed_creation_modules"][module_name] = {}
            sub_config = self.config["sed_creation_modules"][module_name]

181
            for name, (typ, description, default) in \
182
183
184
                    creation_modules.get_module(
                        module_name,
                        blank=True).parameter_list.items():
185
186
187
188
189
190
                if default is None:
                    default = ''
                sub_config[name] = default
                sub_config.comments[name] = wrap(description)

            self.config['sed_creation_modules'].comments[module_name] = [
191
                creation_modules.get_module(module_name, blank=True).comments]
192
193
194
195
196
197

        # Configuration for the analysis method
        self.config['analysis_configuration'] = {}
        self.config.comments['analysis_configuration'] = ["", ""] + wrap(
            "Configuration of the statistical analysis method.")
        module_name = self.config['analysis_method']
198
        for name, (typ, desc, default) in \
199
                analysis_modules.get_module(module_name).parameter_list.items():
200
201
202
203
204
205
            if default is None:
                default = ''
            self.config['analysis_configuration'][name] = default
            self.config['analysis_configuration'].comments[name] = wrap(desc)

        self.config.write()
Yannick Roehlly's avatar
Yannick Roehlly committed
206

207
208
    @property
    def configuration(self):
Yannick Roehlly's avatar
Yannick Roehlly committed
209
        """Returns a dictionary for the session configuration.
Yannick Roehlly's avatar
Yannick Roehlly committed
210
211
212
213
214
215
216

        Returns
        -------
        configuration['data_file'] : string
            File containing the observations to fit.
        configuration['column_list'] : list of strings
            List of the columns of data_file to use in the fitting.
217
        configuration['creation_modules'] : list of strings
Yannick Roehlly's avatar
Yannick Roehlly committed
218
            List of the modules (in the right order) used to create the SEDs.
219
        configuration['creation_modules_params'] : list of dictionaries
Yannick Roehlly's avatar
Yannick Roehlly committed
220
221
            Configuration parameters for each module. To each parameter, the
            dictionary associates a list of possible values (possibly only
Yannick Roehlly's avatar
Yannick Roehlly committed
222
223
224
            one).
        configuration['analysis_method'] : string
            Statistical analysis module used to fit the data.
Yannick Roehlly's avatar
Yannick Roehlly committed
225
226
        configuration['analysis_method_params'] : dictionary
            Parameters for the statistical analysis module. To each parameter
Yannick Roehlly's avatar
Yannick Roehlly committed
227
228
229
230
            is associated a list of possible values.
        """
        configuration = {}

231
        for section in ['data_file', 'column_list', 'creation_modules',
232
                        'analysis_method']:
Yannick Roehlly's avatar
Yannick Roehlly committed
233
234
            configuration[section] = self.config[section]

Yannick Roehlly's avatar
Yannick Roehlly committed
235
        # Parsing the SED modules parameters
236
237
        configuration['creation_modules_params'] = []
        for module in self.config['creation_modules']:
Yannick Roehlly's avatar
Yannick Roehlly committed
238
            module_params = {}
Yannick Roehlly's avatar
Yannick Roehlly committed
239
240
            for key, value in \
                    self.config['sed_creation_modules'][module].items():
Yannick Roehlly's avatar
Yannick Roehlly committed
241
                module_params[key] = evaluate_description(value)
242
            configuration['creation_modules_params'].append(module_params)
243
244

        # Analysis method parameters
245
246
        configuration['analysis_method_params'] = \
            self.config['analysis_configuration']
Yannick Roehlly's avatar
Yannick Roehlly committed
247
248

        return configuration
249
250

    @property
251
    def creation_modules_conf_array(self):
Yannick Roehlly's avatar
Yannick Roehlly committed
252
        """Return the array of all the possible parameter sets from the
253
254
255
        SED creation modules.

        TODO: Maybe it would be more optimal to create an iterator that would
Yannick Roehlly's avatar
Yannick Roehlly committed
256
              iterate over the whole parameter combinations instead of
257
258
259
260
261
              creating the array.

        Returns
        -------
        result : array of arrays of dictionaries
Yannick Roehlly's avatar
Yannick Roehlly committed
262
            The inner arrays contains the various parameter dictionaries
263
            for the modules listed in configuration['creation_modules'].
264
265
266
267

        """

        # First, for each module, we transform the dictionary containing all
Yannick Roehlly's avatar
Yannick Roehlly committed
268
269
        # the possible value for each parameter in a list of dictionaries
        # containing one value for each parameter. We put this list in a list
270
271
        # corresponding to the SED modules one.
        tmp_list = [param_dict_combine(dictionary) for dictionary in
272
                    self.configuration['creation_modules_params']]
273
274
275
276

        # The we use itertools to create an array of all possible
        # combinations.
        return [x for x in itertools.product(*tmp_list)]