API reference

This reference is generated automatically from the docstrings in the source. It is organized by module. The most commonly used objects are re-exported at the top level of the wcc_etc package, so e.g. wcc_etc.Simulation and wcc_etc.simulation.Simulation are the same class.

Top-level public API

get_scene	Get a Scene object with a source, an optional host, and an optional background.
get_scene_from_file	Build a Scene whose source spectrum is read from a wavelength/flux file.
get_scene_element	Generic top level function to instanciate a scene element.
Scene	A collection of SceneElements (source, host, background) representing a full observation scene.
Simulation	A class to manage and run image exposure simulations.
Sensor	A class representing the sensor (detector) properties.
Telescope	A class representing the telescope properties.
ImageSimulator	Render a point source onto a detector grid with noise, driven by an ETC Simulation.
SimulatedImage	Result of an ImageSimulator.simulate() call.
AiryPSF	Diffraction-limited Airy PSF rendered on the detector grid (default).
PolychromaticPSF	Photon-weighted coadd of a base PSF rendered at several wavelengths.
DefocusPSF	A defocused PSF loaded from a bundled FITS product or a Zemax .txt export.
CustomPSF	A custom PSF from an ndarray, a FITS product, or a Huygens .txt export.
effective_wavelength	Photon-weighted effective wavelength of a bandpass times a source SED.
photon_weighted_subbands	Split a band into n_sub sub-bands of equal photon weight.
LightCurveSimulator	Turn a FluxModel into a WCC-observed light curve via the ETC.
LightCurve	Result of a light-curve simulation.
TransitModel	Exoplanet transit light-curve model backed by jaxoplanet.
FluxModel	Base class: map time -> relative flux, normalized to 1.0 out of event.
get_moon_magnitude	Return an approximate V-band magnitude of the Moon.
read_config	Read a single configuration file.
get_sensor_config	Get sensor configuration for a specific detector kind and band.
set_wcc_style	Apply the WCC plotting style to matplotlib's global rcParams.
plot_image_mpl	Plot a single simulated detector image with equal x/y scale.
plot_image_row_mpl	Three panels: PSF+noise, PSF (no noise), and the saturation mask.
plot_radial_mpl	Azimuthally-averaged radial profile of the simulated image.
plot_encircled_energy_mpl	Encircled-energy curve (normalized to 1) of the simulated image.
plot_bandpass_mpl	Plot a filter throughput curve.
plot_lightcurve_mpl	Matplotlib light-curve plot: clean model line, noisy points with error bars, or both.

Modules

• Simulation
  • calculate_bg_normalization_magnitude()
  • Simulation
• Scenes (wcc_etc.scene)
  • get_scene()
  • get_scene_from_file()
  • get_scene_element()
  • Scene
• Sensor
  • Sensor
• Telescope
  • Telescope
• PSF and image simulation (wcc_etc.psfsim)
  • DEFOCUS_REF_WAVELENGTH_M
  • DEFOCUS_REF_FNUM
  • DetectorPSFContext
  • normalize_psf()
  • grid_center()
  • crop_start()
  • center_crop_or_pad()
  • recenter()
  • PSFSource
  • AiryPSF
  • PolychromaticPSF
  • load_huygens_psf()
  • parse_huygens_header()
  • huygens_txt_to_fits()
  • load_psf_fits()
  • WAVELENGTH_SCALING_MODES
  • DefocusPSF
  • CustomPSF
  • saturation_mask_from_image_e()
  • SimulatedImage
  • ImageSimulator
  • howell_center()
  • psf_center()
  • apply_jitter()
  • tiff_to_fits()
  • create_master_flat_from_fits()
  • apply_nl_scaling()
  • FitsImgList
  • FitsImg
  • solve_time_for_snr()
  • RADIUS_TIE_TOL_PIX
  • diffuse_enclosed()
  • aperture_snr_radial()
  • select_aperture()
  • aperture_time_for_snr()
  • calc_hwzm()
  • calc_hwhm()
• Extended sources (wcc_etc.extended)
  • sersic_total_over_amplitude()
  • render_sersic()
• Airy PSF utilities (wcc_etc.airy)
  • get_airy_psf()
  • get_ee_value_at_radius()
  • gaussian_kernel_2d()
  • psf_to_encircled_energy()
  • render_detector_psf()
  • calc_plate_scale_from_flength()
  • get_airy_and_ee_curve_pixel_grid()
  • get_airy_and_ee_curve()
  • jittered_ee_list()
• Radial profiles (wcc_etc.radial_data)
  • radial_data()
  • calc_ee()
• Spectral weighting (wcc_etc.spectral)
  • photon_weights()
  • effective_wavelength()
  • photon_weighted_subbands()
• Light curves (wcc_etc.lightcurve)
  • supersample_factor()
  • LightCurve
  • LightCurveSimulator
• Plotting (wcc_etc.plotting)
  • set_wcc_style()
  • apply_ax_settings()
  • plot_image_mpl()
  • plot_image_row_mpl()
  • plot_radial_mpl()
  • plot_encircled_energy_mpl()
  • plot_bandpass_mpl()
  • plot_lightcurve_mpl()
  • plot_image_bokeh()
  • plot_image_row_bokeh()
  • plot_radial_bokeh()
  • plot_encircled_energy_bokeh()
  • plot_lightcurve_bokeh()
  • plot_snr()
  • plot_snr_vs_mag()
  • plot_sweep()
  • plot_peak_pixel()
  • plot_exptime_for_snr()
  • plot_snr_vs_aperture()
  • plot_psf()
• Astrophysics helpers (wcc_etc.astro)
  • get_moon_magnitude()
• I/O and configuration (wcc_etc.io)
  • read_config()
  • get_sensor_config()
  • resolve_bandpass()
  • VEGA_PATH
  • SENSORFILTER_FOCUS
  • SENSORFILTER_IMPLEMENTED
  • KIND_NAMES