configuration.py 12 KB
Newer Older
1
# -*- coding: utf-8 -*-
2
3
4
# Copyright (C) 2012, 2013 Centre de données Astrophysiques de Marseille
# Licensed under the CeCILL-v2 licence - see Licence_CeCILL_V2-en.txt
# Author: Yannick Roehlly <yannick.roehlly@oamp.fr>
5
6
7
8
9

import atpy
import configobj
import pkg_resources
import pkgutil
10
import collections
11
import itertools
12
13
import numpy as np
from textwrap import wrap
14
from .tools import param_dict_combine
15
from ..data import Database
16
from ..creation_modules import common as modules
17
from ..analysis_modules import common as analysis
18
19
20
21
22


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

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

    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])]
    if 'common' in module_names:
        module_names.remove('common')

    return module_names


Yannick Roehlly's avatar
Yannick Roehlly committed
42
43
44
45
46
47
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:
48
49
50
    - 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.
51
52
53
    - 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
54
55
    - Then the function tries to evaluate the description as a Numpy array of
      float and returns the mere list if this fails.
56

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

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

    """
68
69
70
71
72
73
74
75
76
77
78
79
80
81
    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.
82
            results = [results]
83
84
85
86
87
88
89

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

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


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
101
        Parameters
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
        ----------
        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.")

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

132
133
134
135
136
137
        self.config['redshift_module'] = ""
        self.config.comments['redshift_module'] = [""] + wrap(
            "Module used to redshift the SED before the integration in the "
            "filters. This is a SED creation module that accepts a 'redshift' "
            "parameter (see the documentation).")

138
139
140
        self.config['analysis_method'] = ""
        self.config.comments['analysis_method'] = [""] + wrap(
            "Method used for statistical analysis. Available methods: "
141
            + ', '.join(list_modules('pcigale.analysis_modules')) + ".")
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

        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
        base = Database()
        filter_list = base.get_filter_list()[0]
        base.close()

        # Finding the known filters in the data table
Yannick Roehlly's avatar
Yannick Roehlly committed
160
        obs_table = atpy.Table(self.config['data_file'], verbose=False)
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
        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):
                raise StandardError("The observation table as a {} column "
                                    "but no {} column.".format(column,
                                                               column[:-4]))

        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
180
        # the configuration section from its parameter list.
181
182
183
184
        self.config['sed_creation_modules'] = {}
        self.config.comments['sed_creation_modules'] = ["", ""] + wrap(
            "Configuration of the SED creation modules.")

185
        for module_name in self.config['creation_modules']:
186
187
188
            self.config["sed_creation_modules"][module_name] = {}
            sub_config = self.config["sed_creation_modules"][module_name]

189
            for name, (typ, description, default) in \
190
191
                    modules.get_module(module_name,
                                       blank=True).parameter_list.items():
192
193
194
195
196
197
                if default is None:
                    default = ''
                sub_config[name] = default
                sub_config.comments[name] = wrap(description)

            self.config['sed_creation_modules'].comments[module_name] = [
198
                modules.get_module(module_name, blank=True).comments]
199

200
201
202
203
204
205
206
207
        # Configuration for the redshift module
        self.config['redshift_configuration'] = {}
        self.config.comments['redshift_configuration'] = ["", ""] + wrap(
            "Set the 'redshift' parameter to None (or delete the line). If "
            "there are other parameters, you must give only one value for "
            "each.")
        module_name = self.config['redshift_module']
        for name, (typ, desc, default) in \
208
209
                modules.get_module(module_name,
                                   blank=True).parameter_list.items():
210
211
212
213
214
            if default is None:
                default = ''
            self.config['redshift_configuration'][name] = default
            self.config['redshift_configuration'].comments[name] = wrap(desc)

215
216
217
218
219
        # 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']
220
        for name, (typ, desc, default) in \
221
                analysis.get_module(module_name).parameter_list.items():
222
223
224
225
226
227
            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
228

229
230
    @property
    def configuration(self):
Yannick Roehlly's avatar
Yannick Roehlly committed
231
        """Returns a dictionary for the session configuration.
Yannick Roehlly's avatar
Yannick Roehlly committed
232
233
234
235
236
237
238

        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.
239
        configuration['creation_modules'] : list of strings
Yannick Roehlly's avatar
Yannick Roehlly committed
240
            List of the modules (in the right order) used to create the SEDs.
241
        configuration['creation_modules_params'] : list of dictionaries
Yannick Roehlly's avatar
Yannick Roehlly committed
242
243
            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
244
            one).
245
246
247
        configuration['redshift_module'] : string
        configuration['redshift_configuration'] : dictionary
            Parameters for the redshift module.
Yannick Roehlly's avatar
Yannick Roehlly committed
248
249
        configuration['analysis_method'] : string
            Statistical analysis module used to fit the data.
Yannick Roehlly's avatar
Yannick Roehlly committed
250
251
        configuration['analysis_method_params'] : dictionary
            Parameters for the statistical analysis module. To each parameter
Yannick Roehlly's avatar
Yannick Roehlly committed
252
253
254
255
            is associated a list of possible values.
        """
        configuration = {}

256
        for section in ['data_file', 'column_list', 'creation_modules',
257
                        'redshift_module', 'analysis_method']:
Yannick Roehlly's avatar
Yannick Roehlly committed
258
259
            configuration[section] = self.config[section]

Yannick Roehlly's avatar
Yannick Roehlly committed
260
        # Parsing the SED modules parameters
261
262
        configuration['creation_modules_params'] = []
        for module in self.config['creation_modules']:
Yannick Roehlly's avatar
Yannick Roehlly committed
263
            module_params = {}
Yannick Roehlly's avatar
Yannick Roehlly committed
264
265
            for key, value in \
                    self.config['sed_creation_modules'][module].items():
Yannick Roehlly's avatar
Yannick Roehlly committed
266
                module_params[key] = evaluate_description(value)
267
            configuration['creation_modules_params'].append(module_params)
268
269
270
271
272
273
        # We don't need to "evaluate" the configuration values for the
        # redshit and analysis modules as we don't expect multiple values here.
        configuration['redshift_configuration'] = \
            self.config['redshift_configuration']
        configuration['analysis_method_params'] = \
            self.config['analysis_configuration']
Yannick Roehlly's avatar
Yannick Roehlly committed
274
275

        return configuration
276
277

    @property
278
    def creation_modules_conf_array(self):
Yannick Roehlly's avatar
Yannick Roehlly committed
279
        """Return the array of all the possible parameter sets from the
280
281
282
        SED creation modules.

        TODO: Maybe it would be more optimal to create an iterator that would
Yannick Roehlly's avatar
Yannick Roehlly committed
283
              iterate over the whole parameter combinations instead of
284
285
286
287
288
              creating the array.

        Returns
        -------
        result : array of arrays of dictionaries
Yannick Roehlly's avatar
Yannick Roehlly committed
289
            The inner arrays contains the various parameter dictionaries
290
            for the modules listed in configuration['creation_modules'].
291
292
293
294

        """

        # First, for each module, we transform the dictionary containing all
Yannick Roehlly's avatar
Yannick Roehlly committed
295
296
        # the possible value for each parameter in a list of dictionaries
        # containing one value for each parameter. We put this list in a list
297
298
        # corresponding to the SED modules one.
        tmp_list = [param_dict_combine(dictionary) for dictionary in
299
                    self.configuration['creation_modules_params']]
300
301
302
303

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