synthesizer.parametric.blackholes¶

A module for working with a parametric black holes.

Contains the BlackHole class for use with parametric systems. This houses all the attributes and functionality related to parametric black holes.

Example usages:

bhs = BlackHole(
    bolometric_luminosity,
    mass,
    accretion_rate,
    epsilon,
    inclination,
    spin,
    metallicity,
    offset,
)

Classes

class synthesizer.parametric.blackholes.BlackHole(mass=None, accretion_rate=None, epsilon=0.1, inclination=None, spin=None, offset=unyt_array([0., 0.], 'kpc'), bolometric_luminosity=None, metallicity=None, ionisation_parameter_blr=0.1, hydrogen_density_blr=unyt_quantity(1.e+09, 'cm**(-3)'), covering_fraction_blr=0.1, velocity_dispersion_blr=unyt_quantity(2000, 'km/s'), ionisation_parameter_nlr=0.01, hydrogen_density_nlr=unyt_quantity(10000., 'cm**(-3)'), covering_fraction_nlr=0.1, velocity_dispersion_nlr=unyt_quantity(500, 'km/s'), theta_torus=unyt_quantity(10, 'degree'), **kwargs)[source]¶

The base parametric BlackHole class.

morphology¶

An instance of the PointSource morphology that describes the location of this blackhole

Type:: PointSource

get_mask(attr, thresh, op, mask=None)[source]¶

Create a mask using a threshold and attribute on which to mask.

Parameters:

attr (str) – The attribute to derive the mask from.
thresh (float) – The threshold value.
op (str) – The operation to apply. Can be ‘<’, ‘>’, ‘<=’, ‘>=’, “==”, or “!=”.
mask (array) – Optionally, a mask to combine with the new mask.

Returns:

mask (array): The mask array.