asp_plot.report_captions

asp_plot.report_captions#

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 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#

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

Functions#

`planetary_alignment_description`(instrument)
`planetary_altimetry_histogram`(instrument)
`planetary_altimetry_histogram_aligned`(instrument)
`planetary_altimetry_map`(instrument)
`planetary_altimetry_map_aligned`(instrument)

Module Contents#

asp_plot.report_captions.planetary_alignment_description(instrument)#

asp_plot.report_captions.planetary_altimetry_histogram(instrument)#

asp_plot.report_captions.planetary_altimetry_histogram_aligned(instrument)#

asp_plot.report_captions.planetary_altimetry_map(instrument)#

asp_plot.report_captions.planetary_altimetry_map_aligned(instrument)#

asp_plot.report_captions.BUNDLE_RESIDUALS_LINEAR = 'Initial and final bundle adjustment residuals on a linear scale.'#

asp_plot.report_captions.BUNDLE_RESIDUALS_LOG = 'Initial and final bundle adjustment residuals on a logarithmic scale.'#

asp_plot.report_captions.DEM_RESULTS = 'Output DEM with intersection error map and difference relative to the reference DEM used in processing.'#

asp_plot.report_captions.DETAILED_HILLSHADE = 'DEM hillshade. If the intersection error is available, zoomed subsets selected from low,...#

asp_plot.report_captions.DISPARITY = 'Horizontal and vertical disparity maps in pixels with quiver overlay.'#

asp_plot.report_captions.EARTH_ALIGNMENT_DESCRIPTION = Multiline-String#

Show Value

"""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."""

asp_plot.report_captions.GEODIFF = 'Initial and final geodiff height differences compared to the reference DEM used in processing.'#

asp_plot.report_captions.ICESAT2_HISTOGRAM = 'Distribution of elevation differences between ICESat-2 ATL06-SR and ASP DEM with per-landcover...#

asp_plot.report_captions.ICESAT2_HISTOGRAM_ALIGNED = 'Pre- (steelblue) and post-alignment (orange) distributions of ICESat-2 minus DEM height...#

asp_plot.report_captions.ICESAT2_MAP = 'ICESat-2 ATL06-SR elevation differences vs. ASP DEM.'#

asp_plot.report_captions.ICESAT2_PROFILE = 'Elevation profile along the ICESat-2 track with the most valid points, comparing ATL06-SR and...#

asp_plot.report_captions.ICESAT2_PROFILE_ALIGNED = 'Elevation profile along the ICESat-2 track after pc_align. The aligned DEM is overlaid on the...#

asp_plot.report_captions.ICESAT2_SEGMENTS = "1 km segments along the ICESat-2 track with better (left) and worse (right) agreement with the...#

asp_plot.report_captions.ICESAT2_SEGMENTS_ALIGNED = 'The same better- and worse-agreement segments as above, now with the aligned DEM overlaid....#

asp_plot.report_captions.INPUT_SCENES = "Left and right input scenes used for stereo processing. Non-mapprojected scenes are shown after...#

asp_plot.report_captions.MAP_PROJECTED_RESIDUALS = 'Midpoint distance between final interest points projected onto the reference DEM used in processing.'#

asp_plot.report_captions.MATCH_POINTS = 'Interest point matches between left and right images. These are produced by stereo_corr during...#

asp_plot.report_captions.STEREO_GEOMETRY = 'Stereo acquisition geometry skyplot and map view showing satellite viewing angles and scene footprints.'#