asp_plot.report_captions
========================

.. py:module:: asp_plot.report_captions

.. autoapi-nested-parse::

   Caption and description text for the ``asp_plot`` report sections.

   These strings were previously inlined into the ~880-line ``cli/asp_plot.py``
   ``main()`` control flow. Pulling them into a data module keeps the report
   pipeline (see :mod:`asp_plot.report_pipeline`) focused on orchestration and
   makes the prose reviewable in one place. The body-dependent alignment
   descriptions and the planetary captions are exposed as small template
   functions; everything else is a module-level constant.



Attributes
----------

.. autoapisummary::

   asp_plot.report_captions.BUNDLE_RESIDUALS_LINEAR
   asp_plot.report_captions.BUNDLE_RESIDUALS_LOG
   asp_plot.report_captions.DEM_RESULTS
   asp_plot.report_captions.DETAILED_HILLSHADE
   asp_plot.report_captions.DISPARITY
   asp_plot.report_captions.EARTH_ALIGNMENT_DESCRIPTION
   asp_plot.report_captions.GEODIFF
   asp_plot.report_captions.ICESAT2_HISTOGRAM
   asp_plot.report_captions.ICESAT2_HISTOGRAM_ALIGNED
   asp_plot.report_captions.ICESAT2_MAP
   asp_plot.report_captions.ICESAT2_PROFILE
   asp_plot.report_captions.ICESAT2_PROFILE_ALIGNED
   asp_plot.report_captions.ICESAT2_SEGMENTS
   asp_plot.report_captions.ICESAT2_SEGMENTS_ALIGNED
   asp_plot.report_captions.INPUT_SCENES
   asp_plot.report_captions.MAP_PROJECTED_RESIDUALS
   asp_plot.report_captions.MATCH_POINTS
   asp_plot.report_captions.STEREO_GEOMETRY


Functions
---------

.. autoapisummary::

   asp_plot.report_captions.planetary_alignment_description
   asp_plot.report_captions.planetary_altimetry_histogram
   asp_plot.report_captions.planetary_altimetry_histogram_aligned
   asp_plot.report_captions.planetary_altimetry_map
   asp_plot.report_captions.planetary_altimetry_map_aligned


Module Contents
---------------

.. py:function:: planetary_alignment_description(instrument)

.. py:function:: planetary_altimetry_histogram(instrument)

.. py:function:: planetary_altimetry_histogram_aligned(instrument)

.. py:function:: planetary_altimetry_map(instrument)

.. py:function:: planetary_altimetry_map_aligned(instrument)

.. py:data:: BUNDLE_RESIDUALS_LINEAR
   :value: 'Initial and final bundle adjustment residuals on a linear scale.'


.. py:data:: BUNDLE_RESIDUALS_LOG
   :value: 'Initial and final bundle adjustment residuals on a logarithmic scale.'


.. py:data:: DEM_RESULTS
   :value: 'Output DEM with intersection error map and difference relative to the reference DEM used in processing.'


.. py:data:: DETAILED_HILLSHADE
   :value: 'DEM hillshade. If the intersection error is available, zoomed subsets selected from low,...


.. py:data:: DISPARITY
   :value: 'Horizontal and vertical disparity maps in pixels with quiver overlay.'


.. py:data:: EARTH_ALIGNMENT_DESCRIPTION
   :value: Multiline-String

   .. raw:: html

      <details><summary>Show Value</summary>

   .. code-block:: python

      """ASP's pc_align estimates a rigid 3D translation that minimizes the height residuals between the ASP DEM and ICESat-2 ATL06-SR ground-track points used as the reference point cloud. The translation is applied to the DEM directly (geotransform + pixel-value shift, no resampling) to produce the aligned DEM.
      
      Alignment Parameters (above):
        - processing_level: ATL06-SR filter key used as the reference; 'all' uses every filtered point.
        - minimum_points: minimum ATL06-SR point count required; fewer points skips the alignment.
        - agreement_threshold: maximum relative disagreement across temporal sub-filters before the aligned DEM is flagged as inconsistent.
        - min_translation_threshold: minimum translation magnitude (as a fraction of the DEM GSD) required to write out an aligned DEM.
        - improvement_threshold_pct: minimum percentage reduction in p50 required to keep the aligned DEM on disk; below this, the aligned DEM is removed.
      
      Alignment Statistics (above, in meters):
        - p16_beg / p50_beg / p84_beg: 16th / 50th / 84th percentile of the DEM-vs-ICESat absolute height residuals before alignment.
        - p16_end / p50_end / p84_end: same percentiles after alignment.
        - N_shift / E_shift / D_shift: north / east / down components of the applied translation vector.
        - |T|: magnitude of the translation vector."""

   .. raw:: html

      </details>



.. py:data:: GEODIFF
   :value: 'Initial and final geodiff height differences compared to the reference DEM used in processing.'


.. py:data:: ICESAT2_HISTOGRAM
   :value: 'Distribution of elevation differences between ICESat-2 ATL06-SR and ASP DEM with per-landcover...


.. py:data:: ICESAT2_HISTOGRAM_ALIGNED
   :value: 'Pre- (steelblue) and post-alignment (orange) distributions of ICESat-2 minus DEM height...


.. py:data:: ICESAT2_MAP
   :value: 'ICESat-2 ATL06-SR elevation differences vs. ASP DEM.'


.. py:data:: ICESAT2_PROFILE
   :value: 'Elevation profile along the ICESat-2 track with the most valid points, comparing ATL06-SR and...


.. py:data:: ICESAT2_PROFILE_ALIGNED
   :value: 'Elevation profile along the ICESat-2 track after pc_align. The aligned DEM is overlaid on the...


.. py:data:: ICESAT2_SEGMENTS
   :value: "1 km segments along the ICESat-2 track with better (left) and worse (right) agreement with the...


.. py:data:: ICESAT2_SEGMENTS_ALIGNED
   :value: 'The same better- and worse-agreement segments as above, now with the aligned DEM overlaid....


.. py:data:: INPUT_SCENES
   :value: "Left and right input scenes used for stereo processing. Non-mapprojected scenes are shown after...


.. py:data:: MAP_PROJECTED_RESIDUALS
   :value: 'Midpoint distance between final interest points projected onto the reference DEM used in processing.'


.. py:data:: MATCH_POINTS
   :value: 'Interest point matches between left and right images. These are produced by stereo_corr during...


.. py:data:: STEREO_GEOMETRY
   :value: 'Stereo acquisition geometry skyplot and map view showing satellite viewing angles and scene footprints.'


