simulated_lc¶
- astronify.simulator.simulated_lc(lc_type, lc_ofile='', lc_length=500, lc_noise=0.0, visualize=False, lc_yoffset=100.0, transit_depth=10.0, transit_period=50.0, transit_start=10, transit_width=5, sine_amp=10.0, sine_period=50.0, flare_time=10, flare_amp=100.0, flare_halfwidth=5)[source]¶
Create light curve with specified parameters as a
Table
, and optionally writes a FITS file with the same information.All parameters default to the configuration values.
- Parameters
- lc_typestr
The type of light curve to make. Valid options are ‘flat’, ‘transit’, ‘sine’, and ‘flare’.
- lc_ofilestr or None
Optional. Name of output FITS file. If set to None, no file will be saved to disk.
- lc_lengthint
Optional. Length of the light curve (i.e. the number of flux values).
- lc_noisefloat
Optional. Standard deviation of normal distribution to draw from when adding noise, a value of zero means no noise is added.
- visualizebool
Optional. If True, plot the light curve being made to the screen.
- lc_yoffsetfloat
Optional. Baseline flux level (unitless).
- transit_depth: float
Depth of transit, as a percent (e.g., 10.0 = 10%.)
- transit_periodint
Period of transit (number of fluxes/bins between the start of each event.) (Only relevant for transit type light curve).
- transit_startint
Start index of transit (the index of the flux/bin to use as the start of the first transit event.) (Only relevant for transit type light curve).
- transit_widthint
Width of transit (number of fluxes/bins between the start and end of each event.)
- sine_ampfloat
Amplitude of the sinusoidal signal to add.
- sine_periodfloat
Period of the sinusoidal signal to add.
- flare_time: int
Time corresponding to the maximum flare flux.
- flare_ampfloat
The peak (maximum flux) of the flare.
- flare_halfwidthfloat
The flare half-width (measured in indices) that corresponds to “t_1/2” in the Davenport et al. flare template.
- Returns
- response
Table
The time and flux columns.
- response