solid-waffle
Overview
solid-waffle is a repository designed for analysis of correlations in HxRG flats, with an assortment of other features. The repository contains scripts, configuration files, and utilities to support the characterization of HxRG detectors.
Nota bene: These scripts are not ready for “black box” use in the sense that unanticipated defects in different detectors can cause issues in the stability of the characterization. Some work and testing is required before given results can be trusted. Manual masking is required in some cases, and we are working towards getting this code more streamlined and user-friendly in that regard. Please approach with caution and reach out to the contacts listed below for help.
See the readthedocs page.
Table of Contents
Project Structure
The repository is organized as follows:
Documentation
Some available help on:
Note: If you want the old (non-module) interface, you can use the scripts in legacy_scripts/. But we anticipate that most new code won’t use that.
Files Description
src/solid_waffle/correlation_run.py
Purpose: Main script to call that takes a config file as an argument and runs the analysis.
Key Features:
Detector characterization at basic and advanced levels, including nonlinearity and Brighter-Fatter Effect (BFE)
Hot pixel identification and calculation of interpixel capacitance (IPC)
Summary statistics in superpixels
Visualization such as maps of gain, IPC, BFE over superpixels
If visible light data is supplied as well: Estimates for charge diffusion covariance and quantum yield, also summarized and visualized in outputs
src/solid_waffle/pyirc.py
Purpose: Main utility script containing many functions to load in data, calculate statistics, and estimate corrections.
Details: Includes functions that will read the data in, compute reference pixel corrections, compute gain, do basic characterization, calculate correlations of neighboring pixels, compute BFE coefficients, and more.
src/solid_waffle/ftsolve.py
Purpose: Routines for modeling Fourier-domain correlations across time (Feudenburg et al. 2020).
src/solid_waffle/spr_reduce.py
Purpose: Analysis of single pixel reset data.
Key Features:
Extraction of spatially varying IPC maps from single pixel reset data.
Directories Overview
sample_configs
Description: Sample configuration files.
Key Files:
example_config_wfirst_h4rg_18237: A sample configuration file which is simplified to the basics. This config requires only flat files, dark files, a format code, time frames, and an output location to be specified.
config.vis-sim, config.vis1: Example configuration files for visible light characterization.
ex_sim_config: Example configuration for the flat simulator. Run with python -m solid_waffle.flat_simulator.simulate_flat ex_sim_config
src/solid_waffle/flat_simulator
Description: Scripts and utilities for simulating flat field images.
Key Files:
simulate_flat.py: Main script to generate a simulated flat field.
detector_function.py: Some utility functions called by simulate_flat.py
notebooks
Description: Jupyter notebooks for development, analysis, and visualization. None of these are particularly well described currently.
Key Notebooks:
plotting_tests.ipynb: Shows some visualizations of outputs.
projects
Description: Other projects related to detector characterization that aren’t in the main workflow right now (and aren’t part of the installable module).
Key Sub-Folders:
crnl_tools: Tools for the “direct method” count-rate non-linearity ground test data.
speckle: Tools for speckle fringe data.
Contacts
To communicate about this repository please reach out to:
Chris Hirata (hirata.10 at osu dot edu)
Ami Choi (ami.choi at nasa dot gov)
References
For more detailed background on the concepts and methods used in this project, please refer to:
Main correlation analysis projects for flats and darks:
Hirata, C. & Choi, A. (2020). Brighter-fatter Effect in Near-infrared Detectors. I. Theory of Flat Autocorrelations. Publications of the Astronomical Society of the Pacific, Volume 132, Issue 1007, id. 014501 Link to abstract
Choi, A. & Hirata, C. (2020). Brighter-fatter Effect in Near-infrared Detectors. II. Autocorrelation Analysis of H4RG-10 Flats. Publications of the Astronomical Society of the Pacific, Volume 132, Issue 1007, id. 014502 Link to abstract
Freudenburg, J., Givans, J. et al. (2020). Brighter-fatter Effect in Near-infrared Detectors—III. Fourier-domain Treatment of Flat Field Correlations and Application to WFIRST. Publications of the Astronomical Society of the Pacific, Volume 132, Issue 1013, id.074504 Link to abstract
Givans, J. et al. (2022). Quantum Yield and Charge Diffusion in the Nancy Grace Roman Space Telescope Infrared Detectors. Publications of the Astronomical Society of the Pacific, Volume 134, Issue 1031, id.014001 Link to abstract
Speckle field analysis projects:
Hirata, C. & Merchant, C. (2022). Pixel Centroid Characterization with Laser Speckle and Application to the Nancy Grace Roman Space Telescope Detector Arrays. Publications of the Astronomical Society of the Pacific, Volume 134, Issue 1041, id.115001 Link to abstract
Macbeth, E., Laliotis, K. et al. (2025), in prep.
1 maintainer
Metadata
1 maintainer
Release files for solid-waffle 26.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| solid_waffle-26.0.0.tar.gz | 15.2 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| solid_waffle-26.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 15.3 MB
Release files / solid_waffle-26.0.0.tar.gz
| Download URL | solid_waffle-26.0.0.tar.gz |
|---|---|
| Size | 15.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
96fd05c5c61971f8f29856d5bdd2a69a570e5a5b8a04aa2c41f97037702b99c5
|
|
BLAKE2b-256 checksum How to use checksums |
47822ead4a46c0da1d307980a2728e1dbc8b2434515ce220797b445f54134276
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 30, 2026.
Transparency logRelease files / solid_waffle-26.0.0-py3-none-any.whl
| Download URL | solid_waffle-26.0.0-py3-none-any.whl |
|---|---|
| Size | 84.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8e6cabece5765309fd1dd5ae5f1473971960ae307b1731bd262a6bbe7f484d42
|
|
BLAKE2b-256 checksum How to use checksums |
5b6003cd41f7b7240114907e7ee8fc745c77382f9170e457a79b5d48ec8f2ec2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 30, 2026.
Transparency log
