__init__.py 12.8 KB
Newer Older
Yannick Roehlly's avatar
Yannick Roehlly committed
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
Yannick Roehlly's avatar
Yannick Roehlly committed
5

6
"""
Yannick Roehlly's avatar
Yannick Roehlly committed
7
8
This class represents a Spectral Energy Distribution (SED) as used by pcigale.
Such SED is characterised by:
Yannick Roehlly's avatar
Yannick Roehlly committed
9

Yannick Roehlly's avatar
Yannick Roehlly committed
10
11
- sfh: a tuple (time [Myr], Star Formation Rate [Msun/yr]) representing the
  Star Formation History of the galaxy.
Yannick Roehlly's avatar
Yannick Roehlly committed
12

Yannick Roehlly's avatar
Yannick Roehlly committed
13
14
- modules: a list of tuples (module name, parameter dictionary) containing all
  the pcigale modules the SED 'went through'.
Yannick Roehlly's avatar
Yannick Roehlly committed
15

Yannick Roehlly's avatar
Yannick Roehlly committed
16
- wavelength_grid: the grid of wavelengths [nm] used for the luminosities.
Yannick Roehlly's avatar
Yannick Roehlly committed
17

Yannick Roehlly's avatar
Yannick Roehlly committed
18
19
- contribution_names: the list of the names of the luminosity contributions
  making part of the SED.
Yannick Roehlly's avatar
Yannick Roehlly committed
20

Yannick Roehlly's avatar
Yannick Roehlly committed
21
22
23
24
- luminosities: a two axis numpy array containing all the luminosity density
  [W/nm] contributions to the SED. The index in the first axis corresponds to
  the contribution (in the contribution_names list) and the index of the
  second axis corresponds to the wavelength in the wavelength grid.
Yannick Roehlly's avatar
Yannick Roehlly committed
25

Yannick Roehlly's avatar
Yannick Roehlly committed
26
- info: a dictionary containing various information about the SED.
Yannick Roehlly's avatar
Yannick Roehlly committed
27

Yannick Roehlly's avatar
Yannick Roehlly committed
28
- mass_proportional_info: the list of keys in the info dictionary whose value
Yannick Roehlly's avatar
Yannick Roehlly committed
29
  is proportional to the galaxy mass.
Yannick Roehlly's avatar
Yannick Roehlly committed
30

Yannick Roehlly's avatar
Yannick Roehlly committed
31
"""
Yannick Roehlly's avatar
Yannick Roehlly committed
32

Yannick Roehlly's avatar
Yannick Roehlly committed
33
import numpy as np
34
from collections import OrderedDict
Yannick Roehlly's avatar
Yannick Roehlly committed
35
from . import utils
36
from .io.vo import save_sed_to_vo
37
from scipy.constants import c, parsec
Yannick Roehlly's avatar
Yannick Roehlly committed
38
from scipy.interpolate import interp1d
Yannick Roehlly's avatar
Yannick Roehlly committed
39

40
41
42
43
44
# Time lapse used to compute the average star formation rate. We use a
# constant to keep it easily changeable for advanced user while limiting the
# number of parameters. The value is in Myr.
AV_LAPSE = 100

45

Yannick Roehlly's avatar
Yannick Roehlly committed
46
47
class SED(object):
    """Spectral Energy Distribution with associated information
Yannick Roehlly's avatar
Yannick Roehlly committed
48
49
    """

Yannick Roehlly's avatar
Yannick Roehlly committed
50
51
52
53
54
    def __init__(self, sfh=None):
        """Create a new SED

        Parameters
        ----------
55
        sfh: (numpy.array, numpy.array)
Yannick Roehlly's avatar
Yannick Roehlly committed
56
57
58
59
60
61
            Star Formation History: tuple of two numpy array, the first is the
            time in Myr and the second is the Star Formation Rate in Msun/yr.
            If no SFH is given, it's set to None.

        """
        self.sfh = sfh
Yannick Roehlly's avatar
Yannick Roehlly committed
62
63
64
        self.modules = []
        self.wavelength_grid = None
        self.contribution_names = []
65
        self.luminosity = None
Yannick Roehlly's avatar
Yannick Roehlly committed
66
        self.luminosities = None
67
        self.info = OrderedDict()
68
        self.mass_proportional_info = []
Yannick Roehlly's avatar
Yannick Roehlly committed
69

Yannick Roehlly's avatar
Yannick Roehlly committed
70
71
72
73
74
75
76
77
78
79
80
81
82
    @property
    def sfh(self):
        """Return a copy of the star formation history
        """
        if self._sfh is None:
            return None
        else:
            return np.copy(self._sfh)

    @sfh.setter
    def sfh(self, value):
        self._sfh = value

83
84
        if value:
            sfh_time, sfh_sfr = value
85
            sfh_age = sfh_time[-1] - sfh_time
86
87
            self._sfh = value
            self.add_info("sfr", sfh_sfr[-1], True, True)
88
89
90
            self.add_info("sfr10Myrs", np.mean(sfh_sfr[-10:]),
                          True, True)
            self.add_info("sfr100Myrs", np.mean(sfh_sfr[-100:]),
91
                          True, True)
92
            self.add_info("age", sfh_time[-1], False, True)
93

94
95
96
    @property
    def fnu(self):
        """Total Fν flux density of the SED
Yannick Roehlly's avatar
Yannick Roehlly committed
97

98
99
        Return the total Fν density vector, i.e the total luminosity converted
        to Fν flux in mJy.
Yannick Roehlly's avatar
Yannick Roehlly committed
100
101
        """

Yannick Roehlly's avatar
Yannick Roehlly committed
102
        # Fλ flux density in W/m²/nm
103
104
        f_lambda = utils.luminosity_to_flux(self.luminosity,
                                            self.info['universe.luminosity_distance'])
Yannick Roehlly's avatar
Yannick Roehlly committed
105

106
107
        # Fν flux density in mJy
        f_nu = utils.lambda_flambda_to_fnu(self.wavelength_grid, f_lambda)
Yannick Roehlly's avatar
Yannick Roehlly committed
108

109
        return f_nu
Yannick Roehlly's avatar
Yannick Roehlly committed
110

111
    def add_info(self, key, value, mass_proportional=False, force=False):
Yannick Roehlly's avatar
Yannick Roehlly committed
112
113
114
        """
        Add a key / value to the information dictionary

Yannick Roehlly's avatar
Yannick Roehlly committed
115
        If the key is present in the dictionary, it will raise an exception.
Yannick Roehlly's avatar
Yannick Roehlly committed
116
        Use this method (instead of direct value assignment ) to avoid
117
        overriding an already present information.
Yannick Roehlly's avatar
Yannick Roehlly committed
118

Yannick Roehlly's avatar
Yannick Roehlly committed
119
        Parameters
Yannick Roehlly's avatar
Yannick Roehlly committed
120
        ----------
121
        key: any immutable
Yannick Roehlly's avatar
Yannick Roehlly committed
122
           The key used to retrieve the information.
123
        value: anything
Yannick Roehlly's avatar
Yannick Roehlly committed
124
           The information.
125
        mass_proportional: boolean
126
127
           If True, the added variable is set as proportional to the
           mass.
128
        force: boolean
129
           If false (default), adding a key that already exists in the info
130
131
           dictionary will raise an error. If true, doing this will update
           the associated value.
Yannick Roehlly's avatar
Yannick Roehlly committed
132
133

        """
134
        if (key not in self.info) or force:
Yannick Roehlly's avatar
Yannick Roehlly committed
135
            self.info[key] = value
136
137
            if mass_proportional:
                self.mass_proportional_info.append(key)
Yannick Roehlly's avatar
Yannick Roehlly committed
138
        else:
139
            raise KeyError("The information %s is already present "
Yannick Roehlly's avatar
Yannick Roehlly committed
140
141
                           "in the SED. " % key)

142
143
144
    def add_module(self, module_name, module_conf):
        """Add a new module information to the SED.

Yannick Roehlly's avatar
Yannick Roehlly committed
145
        Parameters
146
        ----------
147
        module_name: string
148
149
            Name of the module. This name can be suffixed with anything
            using a dot.
150
        module_conf: dictionary
Yannick Roehlly's avatar
Yannick Roehlly committed
151
            Dictionary containing the module parameters.
152

Yannick Roehlly's avatar
Yannick Roehlly committed
153
        TODO: Complete the parameter dictionary with the default values from
154
155
              the module if they are not present.

Yannick Roehlly's avatar
Yannick Roehlly committed
156
        """
157
        self.modules.append((module_name, module_conf))
Yannick Roehlly's avatar
Yannick Roehlly committed
158

159
160
161
162
    def add_contribution(self, contribution_name, results_wavelengths,
                         results_lumin):
        """
        Add a new luminosity contribution to the SED.
Yannick Roehlly's avatar
Yannick Roehlly committed
163
164
165
166
167
168
169
170

        The luminosity contribution of the module is added to the contribution
        table doing an interpolation between the current wavelength grid and
        the grid of the module contribution. During the interpolation,
        everything that is outside of the concerned wavelength domain has its
        luminosity set to 0. Also, the name of the contribution is added to
        the contribution names array.

Yannick Roehlly's avatar
Yannick Roehlly committed
171
        Parameters
Yannick Roehlly's avatar
Yannick Roehlly committed
172
        ----------
173
        contribution_name: string
Yannick Roehlly's avatar
Yannick Roehlly committed
174
175
176
177
            Name of the contribution added. This name is used to retrieve the
            luminosity contribution and allows one module to add more than
            one contribution.

178
        results_wavelengths: array of floats
Yannick Roehlly's avatar
Yannick Roehlly committed
179
180
            The vector of the wavelengths of the module results (in nm).

181
        results_lumin: array of floats
Yannick Roehlly's avatar
Yannick Roehlly committed
182
183
184
185
186
187
188
            The vector of the Lλ luminosities (in W/nm) of the module results.

        """
        self.contribution_names.append(contribution_name)

        # If the SED luminosity table is empty, then there is nothing to
        # compute.
189
        if self.luminosity is None:
190
191
192
            self.wavelength_grid = results_wavelengths.copy()
            self.luminosity = results_lumin.copy()
            self.luminosities = results_lumin.copy()
Yannick Roehlly's avatar
Yannick Roehlly committed
193
        else:
194
195
            # If the added luminosity contribution changes the SED wavelength
            # grid, we interpolate everything on a common wavelength grid.
196
197
198
199
200
201
202
203
204
205
206
            if (results_wavelengths.size != self.wavelength_grid.size or
                    not np.all(results_wavelengths == self.wavelength_grid)):
                # Compute the new wavelength grid for the spectrum.
                new_wavelength_grid = utils.best_grid(results_wavelengths,
                                                      self.wavelength_grid)

                # Interpolate each luminosity component to the new wavelength
                # grid setting everything outside the wavelength domain to 0.
                new_luminosities = interp1d(self.wavelength_grid,
                                            self.luminosities,
                                            bounds_error=False,
207
                                            assume_sorted=True,
208
209
210
211
                                            fill_value=0.)(new_wavelength_grid)

                # Interpolate the added luminosity array to the new wavelength
                # grid
212
213
214
                interp_lumin = np.interp(new_wavelength_grid,
                                         results_wavelengths, results_lumin,
                                         left=0., right=0.)
Yannick Roehlly's avatar
Yannick Roehlly committed
215

216
217
                self.wavelength_grid = new_wavelength_grid
                self.luminosities = np.vstack((new_luminosities, interp_lumin))
218
                self.luminosity = self.luminosities.sum(0)
219
220
221
            else:
                self.luminosities = np.vstack((self.luminosities,
                                               results_lumin))
222
                self.luminosity += results_lumin
Yannick Roehlly's avatar
Yannick Roehlly committed
223
224
225
226
227
228
229

    def get_lumin_contribution(self, name):
        """Get the luminosity vector of a given contribution

        If the name of the contribution is not unique in the SED, the flux of
        the last one is returned.

Yannick Roehlly's avatar
Yannick Roehlly committed
230
        Parameters
Yannick Roehlly's avatar
Yannick Roehlly committed
231
        ----------
232
        name: string
Yannick Roehlly's avatar
Yannick Roehlly committed
233
234
235
236
            Name of the contribution

        Returns
        -------
237
        luminosities: array of floats
Yannick Roehlly's avatar
Yannick Roehlly committed
238
239
240
241
242
243
244
            Vector of the luminosity density contribution based on the SED
            wavelength grid.

        """
        # Find the index of the _last_ name element
        idx = (len(self.contribution_names) - 1
               - self.contribution_names[::-1].index(name))
Yannick Roehlly's avatar
Yannick Roehlly committed
245
        return self.luminosities[idx]
Yannick Roehlly's avatar
Yannick Roehlly committed
246

247
    def compute_fnu(self, transmission, lambda_eff):
Yannick Roehlly's avatar
Yannick Roehlly committed
248
249
250
251
252
253
254
255
256
257
258
259
        """
        Compute the Fν flux density corresponding the filter which
        transmission is given.

        As the SED stores the Lλ luminosity density, we first compute the Fλ
        flux density. Fλ is the integration of the Lλ luminosity multiplied by
        the filter transmission, normalised to this transmission and corrected
        by the luminosity distance of the source. This is done by the
        pcigale.sed.utils.luminosity_to_flux function.

        Fλ = luminosity_to_flux( integ( LλT(λ)dλ ) / integ( T(λ)dλ ) )

Yannick Roehlly's avatar
Yannick Roehlly committed
260
        Fλ is in W/m²/nm. At redshift 0, the flux is computed at 10 pc. Then,
Yannick Roehlly's avatar
Yannick Roehlly committed
261
262
263
264
265
266
267
268
269
        to compute Fν, we make the approximation:

        Fν = λeff / c . λeff . Fλ

        Fν is computed in W/m²/Hz and then converted to mJy.

        If the SED spectrum does not cover all the filter response table,
        -99 is returned.

Yannick Roehlly's avatar
Yannick Roehlly committed
270
        Parameters
Yannick Roehlly's avatar
Yannick Roehlly committed
271
        ----------
272
        transmission: 2D array of floats
Yannick Roehlly's avatar
Yannick Roehlly committed
273
274
275
            A numpy 2D array containing the filter response profile
            wavelength[nm] vs transmission).

276
        lambda_eff: float
Yannick Roehlly's avatar
Yannick Roehlly committed
277
278
279
280
            Effective wavelength of the filter in nm.

        Return
        ------
281
        fnu: float
Yannick Roehlly's avatar
Yannick Roehlly committed
282
283
284
            The integrated Fν density in mJy.
        """

285
        # Filter limits
286
287
        lambda_min = transmission[0][0]
        lambda_max = transmission[0][-1]
Yannick Roehlly's avatar
Yannick Roehlly committed
288

289
290
291
292
        wavelength = self.wavelength_grid
        l_lambda = self.luminosity

        # Test if the spectrum cover all the filter extend
293
294
        if ((wavelength[0] > lambda_min) or
                (wavelength[-1] < lambda_max)):
Yannick Roehlly's avatar
Yannick Roehlly committed
295
296
297
298
299
300
            f_nu = -99.

        else:
            # We regrid both spectrum and filter to the best wavelength grid
            # to avoid interpolating a high wavelength density curve to a low
            # density one. Also, we limit the work wavelength domain to the
301
302
303
304
            # filter one.

            w = np.where((wavelength >= lambda_min)&(wavelength <= lambda_max))
            wavelength_r = utils.best_grid(wavelength[w], transmission[0])
Yannick Roehlly's avatar
Yannick Roehlly committed
305
306
307
308
309

            l_lambda_r = np.interp(wavelength_r, wavelength, l_lambda)
            transmission_r = np.interp(wavelength_r, transmission[0],
                                       transmission[1])

310
311
            if 'universe.luminosity_distance' in self.info.keys():
                dist = self.info['universe.luminosity_distance']
312
            else:
313
                dist = 10. * parsec
314

Yannick Roehlly's avatar
Yannick Roehlly committed
315
            f_lambda = utils.luminosity_to_flux(
316
317
                np.trapz(transmission_r * l_lambda_r, wavelength_r),
                dist)
Yannick Roehlly's avatar
Yannick Roehlly committed
318

319
320
            # Fν in W/m²/Hz. The 1e-9 factor is because λ is in nm.
            f_nu = lambda_eff * f_lambda * lambda_eff * 1e-9 / c
Yannick Roehlly's avatar
Yannick Roehlly committed
321
322

            # Conversion from W/m²/Hz to mJy
323
            f_nu *= 1e+29
Yannick Roehlly's avatar
Yannick Roehlly committed
324
325

        return f_nu
326
327
328
329
330
331
332

    def to_votable(self, filename, mass=1.):
        """
        Save the SED to a VO-table file

        Parameters
        ----------
333
        filename: string
334
            Name of the VO-table file
335
        mass: float
336
337
338
339
340
            Galaxy mass in solar mass. When need, the saved data will be
            multiplied by this mass.

        """
        save_sed_to_vo(self, filename, mass)
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358

    def copy(self):
        sed = SED()
        sed.sfh = (self._sfh[0].copy(), self._sfh[1].copy())
        sed.modules = self.modules[:]
        if self.wavelength_grid is not None:
            sed.wavelength_grid = self.wavelength_grid.copy()
            sed.luminosity = self.luminosity.copy()
            sed.luminosities = self.luminosities.copy()
        else:
            sed.wavelength_grid = None
            sed.luminosity = None
            sed.luminosities = None
        sed.contribution_names = self.contribution_names[:]
        sed.info = self.info.copy()
        sed.mass_proportional_info = self.mass_proportional_info[:]

        return sed