Star#
- class fleck.Star(spot_contrast, u_ld, phases=None, n_phases=None, rotation_period=None)[source]#
Bases:
object
Object describing properties of a (population of) star(s)
- Parameters:
Methods Summary
light_curve
(spot_lons, spot_lats, ...[, ...])Generate a(n ensemble of) light curve(s).
plot
(spot_lons, spot_lats, spot_radii, ...)Generate a plot of the stellar surface at
time
.spherical_to_cartesian
(spot_lons, spot_lats, ...)Convert spot parameter matrices in the original stellar coordinates to rotated and tilted cartesian coordinates.
Methods Documentation
- light_curve(spot_lons, spot_lats, spot_radii, inc_stellar, planet=None, times=None, fast=False, time_ref=None, return_spots_occulted=False, transit_model_kwargs={})[source]#
Generate a(n ensemble of) light curve(s).
Light curve output will have shape
(n_phases, len(inc_stellar))
or(len(times), len(inc_stellar))
.- Parameters:
- spot_lons
ndarray
Spot longitudes
- spot_lats
ndarray
Spot latitudes
- spot_radii
ndarray
Spot radii
- inc_stellar
ndarray
Stellar inclinations
- planet
TransitParams
, optional Transiting planet parameters
- times
ndarray
, optional Times at which to compute the light curve
- fastbool, optional
When
True
, use approximation that spots are fixed on the star during a transit event. WhenFalse
, account for motion of starspots on stellar surface due to rotation during transit event. Default isFalse
.- time_reffloat, optional
Reference time used as the initial rotational phase of the star, such that the sub-observer point is at zero longitude at
time_ref
.- return_spots_occultedbool, optional
Return whether or not spots have been occulted.
- spot_lons
- Returns:
- light_curves
ndarray
Stellar light curves of shape
(n_phases, len(inc_stellar))
or(len(times), len(inc_stellar))
- light_curves
- plot(spot_lons, spot_lats, spot_radii, inc_stellar, time=None, planet=None, ax=None, time_ref=0)[source]#
Generate a plot of the stellar surface at
time
.Takes the same arguments as
light_curve
with the exception of the singulartime
rather thantimes
, plusax
for pre-defined matplotlib axes.Coordinate frame is the “observer oriented” view defined in Fabrycky & Winn (2009) Figure 1a. The planet transits from left to right across the image. The dashed gray lines represent the upper and lower bounds of the planet’s transit chord.
- Parameters:
- spot_lons
Quantity
Spot longitudes
- spot_lats
Quantity
Spot latitudes
- spot_radii
ndarray
Spot radii
- inc_stellar
Quantity
Stellar inclination
- timefloat
Time at which to evaluate the spot parameters
- planet
TransitParams
or list Planet parameters, or list of planet parameters.
- ax
Axes
, optional Predefined matplotlib axes
- time_reffloat
Reference time used as the initial rotational phase of the star, such that the sub-observer point is at zero longitude at
time_ref
.
- spot_lons
- Returns:
- ax
Axes
Axis object.
- ax
- spherical_to_cartesian(spot_lons, spot_lats, inc_stellar, times=None, planet=None, time_ref=None)[source]#
Convert spot parameter matrices in the original stellar coordinates to rotated and tilted cartesian coordinates.
- Parameters:
- spot_lons
Quantity
Spot longitudes
- spot_lats
Quantity
Spot latitudes
- inc_stellar
Quantity
Stellar inclination
- times
ndarray
Times at which evaluate the stellar rotation
- planet
TransitParams
Planet parameters
- time_reffloat
Reference time used as the initial rotational phase of the star, such that the sub-observer point is at zero longitude at
time_ref
.
- spot_lons
- Returns:
- tilted_spots
ndarray
Rotated and tilted spot positions in cartesian coordinates
- tilted_spots