Developer Guide

ts_imsim is a package designed to create Rubin Observatory Active Optics Sysytem (AOS) simulations using imSim. The main functionality is designed around simulations of the Rubin AOS closed loop using the Rubin Wavefront Estimation Pipeline (WEP) and Optical Feedback Control (OFC). In each iteration of the closed loop ts_imsim generates images for a configuration of the Simonyi Survey Telescope using LSSTCam or LSST ComCam, generates wavefront estimates in terms of Zernike polynomials using WEP, and derives corrections to improve image quality based upon those estimates with OFC. The updated telescope configuration is then used to simulate images for the next iteration. After a number of iterations the AOS system should converge upon a stable configuration that produces the best image quality based upon the perturbations in the initial configuration.

Modules

The classes and files for each module are listed below.

imsim

This module contains the closed loop methods.

classDiagram namespace ts_ofc { class OFCCalculation } CloseLoopTask o-- SkySim CloseLoopTask o-- OFCCalculation CloseLoopTask o-- ImsimCmpt CloseLoopTask o-- OpdMetrology CloseLoopTask *-- ObsMetadata ImsimCmpt *-- ObsMetadata ImsimCmpt o-- OpdMetrology

Figure 1 Class diagram of ts_imsim.

  • ClosedLoopTask: Run the imSim based closed loop for AOS.

  • ImsimCmpt: Handle I/O with imSim and create configuration files for the simulations.

  • ObsMetadata: Class for storing observation metadata.

  • OpdMetrology: Calculate Optical Path Difference (OPD) related metrology.

  • SkySim: Create simulated sky catalogs.

imsim.utils

This module contains utility functions that are used in main imsim module.

  • metroTool: OPD metrology related functions.

  • plotUtil: Functions to plot summary information on closed loop results.

  • SensorWavefrontError: Class to contain the wavefront errors for a single sensor.

  • utility: I/O utility functions and ModifiedEnvironment class to help with mac OS port.

Python API reference

This section is autogenerated from docstrings.

lsst.ts.imsim Package

Classes

ClosedLoopTask()

Initialization of the closed loop task class to run the simulation with imSim.

ImsimCmpt(num_of_zk)

Class to take configurations for each imsim component and generate full imsim configuration files.

ObsMetadata(ra, dec, band[, rotator_angle, ...])

Class for storing observation metadata.

OpdMetrology()

Initialization of OPD metrology class.

SkySim()

Initialization of sky simulator class.

lsst.ts.imsim.utils Package

Functions

atm_sf(D, m, wl_um, zen, r0_in_m_ref, model)

Get the atmosphere phase structure function.

calc_pssn(array, wl_um[, input_data_type, ...])

Calculate the normalized point source sensitivity (PSSN).

create_atm(wl_um, fwhm_in_arcsec, grid_size, ...)

Calculate the weighting function for a certain atmosphere model.

create_mtf_atm(D, m, k, wl_um, zen, r0_in_m_ref)

Generate the modulation transfer function (MTF) for atmosphere.

get_camera(cam_type)

Returns a lsst instrument for a given instrument name.

get_config_dir()

Get the directory of configuration files.

get_module_path()

Get the path of module.

get_policy_path()

Get the path of the policy directory.

get_zk_from_file(zk_file_path)

Get the zk (z4-z22) from file.

make_dir(new_dir[, exist_ok])

Make the new directory.

opd_to_psf(opd, pupil, wavelength[, ...])

Optical path difference (OPD) to point spread function (PSF).

otf_to_psf(otf)

Optical transfer function (OTF) to point spread function (PSF).

plot_fwhm_of_iters(pssn_files[, ...])

Plot the FWHM of iteration.

psf_to_ellip_atm_weighted(array, wl_um[, ...])

Calculate the ellipticity with the error of atmosphere and weighting function.

psf_to_ellip_weighted(psf, pix_in_um, wl_um)

Calculate the ellipticity with the weighting function.

psf_to_otf(psf)

Point spread function (PSF) to optical transfer function (OTF).

r0_wl_zen(r0_in_m_ref, zen, wl_um)

Get the atomosphere reference r0, which is a function of zenith angle and wavelength.

Classes

CamType(value[, names, module, qualname, ...])

Define allowed camera types.

ModifiedEnvironment(**kwargs)

Context manager to temporarily modify shell environment with specified overrides.

SensorWavefrontError([num_of_zk])

Contains the wavefront errors for a single sensor.

WepEstimator(value[, names, module, ...])

Define allowed WEP Zernike estimator methods.

Contributing

To contribute, please start a new pull request on GitHub. Feature requests shall be filed in JIRA with ts_aos as the component. In all cases, reaching out to the contacts for this module is recommended.