FaculaCollection

class vspec_vsm.FaculaCollection(*faculae: Tuple[Facula], grid_params: int | Tuple[int, int] = (500, 1000), gridmaker: CoordinateGrid = None)

Bases: object

Container class to store faculae.

Parameters:

• *faculae (tuple) – A series of faculae objects.

• nlat (int, default=500) – The number of latitude points on the stellar sufrace.

• nlon (int, default=1000) – The number of longitude points on the stellar surface.

• gridmaker (CoordinateGrid, default=None) – A CoordinateGrid object to create the stellar sufrace grid.

faculae

Series of faculae objects.

Type:

tuple

gridmaker

A CoordinateGrid object to create the stellar sufrace grid.

Type:

CoordinateGrid, default=None

Attributes:

gridmaker

Methods

add_faculae(facula)	Add a facula or faculae
age(time)	Age spots according to their growth timescale and decay rate.
clean_faclist()	Remove faculae that have decayed to Rmax/e**2 radius.
map_pixels(pixmap, star_rad, star_teff)
set_gridmaker(gridmaker)	Set the gridmaker attribute safely.

Attributes Summary

gridmaker

Methods Summary

add_faculae(facula)	Add a facula or faculae
age(time)	Age spots according to their growth timescale and decay rate.
clean_faclist()	Remove faculae that have decayed to Rmax/e**2 radius.
map_pixels(pixmap, star_rad, star_teff)
set_gridmaker(gridmaker)	Set the gridmaker attribute safely.

Attributes Documentation

gridmaker: CoordinateGrid = None

Methods Documentation

add_faculae(facula: Tuple[Facula]) → None

Add a facula or faculae

Parameters:

facula (Facula or series of Facula) – Facula object(s) to add.

age(time: astropy.units.Quantity) → None

Age spots according to their growth timescale and decay rate. Remove spots that have decayed.

Parameters:

time (astropy.units.Quantity) – Length of time to age the spot. For most realistic behavior, time should be << spot lifetime.

clean_faclist() → None

Remove faculae that have decayed to Rmax/e**2 radius.

map_pixels(pixmap, star_rad, star_teff)

Deprecated since version 0.1: This functionality is now performed by the Star object.

Map facula parameters to pixel locations

Parameters:

• pixmap (astropy.units.Quantity , shape(M,N)) – Grid of effective temperature.

• star_rad (astropy.units.Quantity) – Radius of the star.

• star_teff (astropy.units.Quantity) – Temperature of quiet stellar photosphere.

Returns:

• int_map (np.ndarray) – Grid of integer keys showing facula locations.

• map_dict (dict) – Dictionary mapping index in self.faculae to the integer grid of facula locations.

set_gridmaker(gridmaker: CoordinateGrid)

Set the gridmaker attribute safely.

Parameters:

gridmaker (VSPEC.helpers.CoordinateGrid) – The CoordinateGrid object to set