PlummerSP

class artpop.source.PlummerSP(sp, scale_radius, xy_dim, pixel_scale, dx=0, dy=0, labels=None)

Bases: Source

Simple stellar population with a Plummer spatial distribution.

Parameters

spStellarPopulation

A stellar population object.

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.

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 is 0.2 arcsec / pixel.

dxfloat, optional

Shift from center of image in the x direction.

dyfloat, optional

Shift from center of image in the y direction.

labelslist-like, optional

Labels for the stars. For example, EEP values (int or float) or name of evolutionary phase (str).

Attributes Summary

num_stars	Number of stars in source
x	x coordinates
y	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.