Welcome to yippy Documentation

yippy is a package designed to read a “Yield Input Package” (YIP) in Python and generate the off-axis PSFs, stellar intensity maps, and sky transmission maps.

Quick Links

Getting Started

• What is inside a “yield input package” (YIP)?
  • YIP files
  • YIP file descriptions
  • Quickstart
  • Important caveats
• Available YIPs and Downloading
  • Available datasets
  • Sampling
  • Downloading a YIP via fetch_yip
  • Cache location
  • Discovery helpers
  • Migration from fetch_coronagraph

YIP Internals

• Radially symmetric off-axis PSFs
  • The offsets
  • The PSFs
  • Using yippy
  • Interpolation in 2D
• Quarter symmetric off-axis PSFs
  • The offsets
  • The PSFs
  • Using yippy
• Stellar Intensity Maps
  • The diameters
  • The stellar intensity maps themselves
  • Using yippy
• Sky Transmission
• Fourier Interpolation
  • Conceptual foundations
  • Moving a 2D image in 1 dimension
  • Why is it wrong?
  • 1D shift

Performance Metrics

• Performance Metrics Overview
  • Acknowledgments
  • Two ETC Families
  • Metrics at a Glance
  • Summary Panel
  • How Metrics Feed Into ETCs
• Core Throughput
  • Theory
  • Fixed Circular Aperture
  • PSF Truncation Ratio (AYO Mode)
• Stellar Leakage and Contrast
  • Theory
  • Contrast Measurement Animation
  • Raw Contrast Curve
  • Core Mean Intensity
• Spatial Metrics and Backgrounds
  • Theory
  • Core Area: Fixed Aperture
  • Core Area: Truncation Ratio Animation
  • Occulter Transmission
• Noise Floors and Integration Time
  • Two Noise Floor Conventions
  • Noise Floor Comparison
  • Integration Time Equations
• Aperture Photometry: Fixed Circle vs PSF Truncation
  • Fixed Circular Aperture (EXOSIMS)
  • PSF Truncation Mask (AYO)
  • Side-by-Side: Aperture Shape Comparison
  • Consistent Noise Metric
  • AYO’s Per-Separation Optimization
  • Discussion
• Noise Floor Conventions
  • Two Conventions, Same Physics
  • Comparing the Two Conventions
  • Verifying Algebraic Equivalence
  • Effect of Post-Processing Factor
  • Which Convention to Use
  • References

Reference

• Azimuthal Averaging of Stellar Intensity
  • Background
  • Two Approaches
  • Comparison
  • Radial Binning Parameters
  • Recommendation
• Benchmarking: Yippy vs AYO
  • Key Results

Development

• Changelog
• API Reference