synthesizer.parametric.metal_dist¶

A submodule for creating and manipulating metallicity distributions.

NOTE: This module is imported as ZDist in parametric.__init__ enabling the: syntax shown below.

Example usage:

from synthesizer.parametric import ZDist

print(ZDist.parametrisations)

metal_dist = ZDist.DeltaConstant(…) metal_dist = ZDist.Normal(…)

metal_dist.get_dist_weight(metals)

Classes

class synthesizer.parametric.metal_dist.Common(name, **kwargs)[source]¶

The parent class for all ZDist parametrisations.

name¶

The name of this ZDist. This is set by the child and encodes the type of the metallicity distribution. Possible values are defined in parametrisations above.

Type:: str

parameters¶

A dictionary containing the parameters of the model.

Type:: dict

get_bin_weights(edges)[source]¶

Get the weight of each metallicity bin.

Parameters:: edges (np.ndarray of float) – The (linear) metallicity bin edges.
Returns:: The integrated weight in each bin.
Return type:: np.ndarray of float

get_cdf(metals)[source]¶

Get the weight between a metallicity of zero and each metallicity.

Children with a closed form override this, the default integrates the distribution numerically with Gauss-Legendre quadrature over log spaced panels whose edges include the requested metallicities.

Parameters:: metals (np.ndarray of float) – The (linear) metallicities at which to evaluate the CDF.
Returns:: The integrated weight up to each metallicity.
Return type:: np.ndarray of float

get_dist_weight(metal)[source]¶

Return the weight of the bin/s defined by metal.

Parameters:: metal (float/np.ndarray of float) – The metallicity bin/s to evaluate.
Returns:: The weight at metal or each value in metal.
Return type:: float

Examples using `synthesizer.parametric.metal_dist.Common`¶

Extreme model variations example

Plot model variations example

Photometry example

Plot spectra example

Create image example

Plot delta_lambda for a grid.

Demonstrate the dense basis approach for describing the SFZH

Plot equivalent width for UV indices

Generating Lines from a Parametric Galaxy

Generate parametric observed SED

An example showing how to scale a galaxy’s mass by luminosity/flux.

An example showing how to scale a galaxy's mass by luminosity/flux.

Generate parametric galaxy SED

Compare SPS grid assignment methods

Compare parametric and particle SEDs

Create sampled SED

Plot line of sight optical depth calculations

Plot line of sight diagnostics

Spatial resampling with parametric SFH and MetalDist

class synthesizer.parametric.metal_dist.DeltaConstant(metallicity=None, log10metallicity=None)[source]¶

A single metallicity “distribution”.

metallicity_¶

The single (linear) metallicity for all stellar mass in the distribution.

Type:: float

log10metallicity_¶

The log base 10 of metallicity.

Type:: float

get_log10_metallicity(*args)[source]¶

Return the log base 10 of the single metallicity.

NOTE: DeltaConstant is a special case where get_dist_weight is not applicable because a single metallicity must always be rather than a weight.

Returns:

float: The log10(metallicity).

get_metallicity(*args)[source]¶

Return the single metallicity.