MISTPlummerSSP¶
- class artpop.source.MISTPlummerSSP(log_age, feh, phot_system, scale_radius, distance, xy_dim, pixel_scale, num_stars=None, total_mass=None, a_lam=0.0, add_remnants=True, mag_limit=None, mag_limit_band=None, imf='kroupa', imf_kw=None, mist_path='/home/docs/.artpop/mist', mass_tolerance=0.01, dx=0, dy=0, label_type=None, random_state=None)[source]¶
Bases:
PlummerSP
MIST simple stellar population with a Plummer spatial distribution.
Note
You must give
total_mass
ornum_stars
.- Parameters
- log_agefloat
Log (base 10) of the simple stellar population age in years.
- fehfloat
Metallicity [Fe/H] of the simple stellar population.
- phot_systemstr or list-like
Name of the photometric system(s).
- scale_radiusfloat or
Quantity
Scale radius of the source. If a float is given, the units are assumed to be
kpc
. Must be greater than zero.- distancefloat or
Quantity
Distance to source. If float is given, the units are assumed to be
Mpc
.- xy_dimint or list-like
Dimensions of the mock image in xy coordinates. If int is given, will make the x and y dimensions the same.
- pixel_scalefloat or
Quantity
The pixel scale of the mock image. If a float is given, the units will be assumed to be
arcsec / pixels
. Default is0.2 arcsec / pixel
.- num_starsint or
None
Number of stars in source. If
None
, then must givetotal_mass
.- total_massfloat or
None
Stellar mass of the source. If
None
, then must givenum_stars
. This mass accounts for stellar remnants, so the actual sampled mass will be less than the given value.- a_lamfloat or dict, optional
Magnitude(s) of extinction. If float, the same extinction will be applied to all bands. If dict, the keys must be the same as the observational filters.
- add_remnantsbool, optional
If True (default), apply scaling factor to total mass to account for stellar remnants in the form of white dwarfs, neutron stars, and black holes.
- mag_limitfloat, optional
Only sample individual stars that are brighter than this magnitude. All fainter stars will be combined into an integrated component. Otherwise, all stars in the population will be sampled. You must also give the
mag_limit_band
if you use this parameter.- mag_limit_bandstr, optional
Bandpass of the limiting magnitude. You must give this parameter if you use the
mag_limit
parameter.- imfstr, optional
The initial stellar mass function. Default is
'kroupa'
.- imf_kwdict, optional
Optional keyword arguments for sampling the stellar mass function.
- mist_pathstr, optional
Path to MIST isochrone grids. Use this if you want to use a different path from the
MIST_PATH
environment variable.- mass_tolerancefloat, optional
Tolerance in the fractional difference between the input mass and the final mass of the population. The parameter is only used when
total_mass
is given.- dxfloat, optional
Shift from center of image in the x direction.
- dyfloat, optional
Shift from center of image in the y direction.
- label_typestr, optional
If not None, the type of labels to pass to the
Source
object. Can bephases
or an attribute ofMISTSSP
.- random_state
None
, int, list of ints, orRandomState
If
None
, return theRandomState
singleton used bynumpy.random
. Ifint
, return a newRandomState
instance seeded with theint
. IfRandomState
, return it. Otherwise raiseValueError
.
Attributes Summary
Number of stars in source
x coordinates
y coordinates
Methods Summary
copy
()Create deep copy of source object.
mag_to_image_amplitude
(m_tot, zpt)Convert total magnitude into amplitude parameter for the smooth model.
select_stars
(label)Return boolean mask that is set to True for stars of given label.
Attributes Documentation
- num_stars¶
Number of stars in source
- x¶
x coordinates
- y¶
y coordinates
Methods Documentation
- copy()¶
Create deep copy of source object.
- mag_to_image_amplitude(m_tot, zpt)¶
Convert total magnitude into amplitude parameter for the smooth model.
- Parameters
- m_totfloat
Total magnitude in the smooth component of the system.
- zptfloat
Photometric zero point.
- Returns
- mu_0float
Central surface brightness of the Plummer distribution in mags per square arcsec.
- amplitudefloat
Amplitude parameter for the smooth model in image flux units.
- param_namestr
Name of amplitude parameter (needed to set its value when generating the smooth model).
- select_stars(label)¶
Return boolean mask that is set to True for stars of given label.