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.
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).
DefocusPSF	A defocused PSF loaded from a Zemax Huygens text file.
CustomPSF	A custom PSF from an ndarray or a Huygens-format text file (future hook).
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.

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)
  • DetectorPSFContext
  • normalize_psf()
  • center_crop_or_pad()
  • recenter()
  • PSFSource
  • AiryPSF
  • load_huygens_psf()
  • 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()
  • aperture_snr_radial()
  • select_aperture()
  • aperture_time_for_snr()
  • calc_hwzm()
  • calc_hwhm()
• 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_image_bokeh()
  • plot_image_row_bokeh()
  • plot_radial_bokeh()
  • plot_encircled_energy_bokeh()
  • plot_lightcurve_mpl()
  • plot_lightcurve_bokeh()
• Astrophysics helpers (wcc_etc.astro)
  • get_moon_magnitude()
• I/O and configuration (wcc_etc.io)
  • read_config()
  • get_sensor_config()
  • resolve_bandpass()