Skip to content

[DOCS] Add SVG visuals for 12 raster functions (Phase 12)#2695

Merged
jiayuasu merged 3 commits intomasterfrom
fix/issue-2678-phase12
Mar 7, 2026
Merged

[DOCS] Add SVG visuals for 12 raster functions (Phase 12)#2695
jiayuasu merged 3 commits intomasterfrom
fix/issue-2678-phase12

Conversation

@jiayuasu
Copy link
Member

@jiayuasu jiayuasu commented Mar 6, 2026

Summary

Add SVG visual illustrations for 12 raster functions, replacing old PNG visuals where applicable.

Functions covered (15 SVGs total):

  • Raster Operators: RS_Clip, RS_Interpolate, RS_ReprojectMatch, RS_NormalizeAll, RS_Resample, RS_Union
  • Raster Aggregate: RS_Union_Aggr
  • Raster Map Algebra: RS_MapAlgebra
  • Raster Band Accessors: RS_ZonalStats, RS_ZonalStatsAll
  • Raster Accessors: RS_RasterToWorldCoord, RS_WorldToRasterCoord

Additional visuals:

  • RS_ReprojectMatch_clip: shows input being clipped to reference extent
  • RS_ZonalStats_allTouched / RS_ZonalStatsAll_allTouched: allTouched parameter comparison

Highlights:

  • RS_Resample: shows both upsample (3×3→6×6) and downsample (6×6→3×3) with NearestNeighbor, Bilinear, and Bicubic algorithms with computed pixel values
  • RS_ReprojectMatch: two SVGs showing NoData padding (input smaller) and clipping (input larger)
  • Old PNG references removed from RS_Clip, RS_Interpolate, RS_ReprojectMatch

Partially addresses #2678

Functions: RS_Clip, RS_Interpolate, RS_ReprojectMatch, RS_NormalizeAll, RS_Resample, RS_Union, RS_Union_Aggr, RS_MapAlgebra, RS_ZonalStats, RS_ZonalStatsAll, RS_RasterToWorldCoord, RS_WorldToRasterCoord. Extra: RS_ReprojectMatch_clip, RS_ZonalStats_allTouched, RS_ZonalStatsAll_allTouched. Removed old PNG references. Partially addresses #2678.
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds new SVG-based illustrations for multiple raster SQL functions to improve documentation clarity and replace legacy PNG visuals, helping address #2678.

Changes:

  • Added new SVG diagrams for RS_* raster functions (e.g., Clip, Interpolate, ReprojectMatch, Union, ZonalStats, coord accessors).
  • Embedded the new SVGs into the corresponding function documentation pages.
  • Removed legacy PNG output image references where applicable.

Reviewed changes

Copilot reviewed 12 out of 27 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/image/RS_Clip/RS_Clip.svg New SVG illustrating crop=true/false behavior and NoData outside geometry.
docs/image/RS_Interpolate/RS_Interpolate.svg New SVG illustrating IDW interpolation inputs/outputs.
docs/image/RS_MapAlgebra/RS_MapAlgebra.svg New SVG illustrating multi-band map algebra (NDVI example).
docs/image/RS_NormalizeAll/RS_NormalizeAll.svg New SVG illustrating normalization from input range to [0,255].
docs/image/RS_RasterToWorldCoord/RS_RasterToWorldCoord.svg New SVG illustrating raster-to-world coordinate conversion.
docs/image/RS_WorldToRasterCoord/RS_WorldToRasterCoord.svg New SVG illustrating world-to-raster coordinate conversion.
docs/image/RS_ReprojectMatch/RS_ReprojectMatch.svg New SVG illustrating padding with NoData when input doesn’t cover reference extent.
docs/image/RS_ReprojectMatch_clip/RS_ReprojectMatch_clip.svg New SVG illustrating clipping when input extent exceeds reference extent.
docs/image/RS_Union/RS_Union.svg New SVG illustrating unioning rasters into a multi-band output.
docs/image/RS_Union_Aggr/RS_Union_Aggr.svg New SVG illustrating RS_Union_Aggr grouping into a multi-band raster.
docs/image/RS_ZonalStats/RS_ZonalStats.svg New SVG illustrating zonal stats over a zone geometry.
docs/image/RS_ZonalStatsAll/RS_ZonalStatsAll.svg New SVG illustrating multi-stat zonal summary output.
docs/image/RS_ZonalStats_allTouched/RS_ZonalStats_allTouched.svg New SVG comparing allTouched=false vs true selection.
docs/image/RS_ZonalStatsAll_allTouched/RS_ZonalStatsAll_allTouched.svg New SVG comparing allTouched=false vs true selection (All variant).
docs/api/sql/Raster-Operators/RS_Clip.md Adds SVG illustration and removes legacy PNG references.
docs/api/sql/Raster-Operators/RS_Interpolate.md Adds SVG illustration and removes legacy PNG references.
docs/api/sql/Raster-Map-Algebra-Operators/RS_MapAlgebra.md Adds SVG illustration to Map Algebra docs.
docs/api/sql/Raster-Operators/RS_NormalizeAll.md Adds SVG illustration to NormalizeAll docs.
docs/api/sql/Raster-Operators/RS_ReprojectMatch.md Adds SVG illustrations and removes legacy PNG reference.
docs/api/sql/Raster-Operators/RS_Resample.md Adds SVG illustration to Resample docs.
docs/api/sql/Raster-Operators/RS_Union.md Adds SVG illustration to Union docs.
docs/api/sql/Raster-Aggregate-Functions/RS_Union_Aggr.md Adds SVG illustration to Union_Aggr docs.
docs/api/sql/Raster-Band-Accessors/RS_ZonalStats.md Adds SVG illustrations including allTouched comparison.
docs/api/sql/Raster-Band-Accessors/RS_ZonalStatsAll.md Adds SVG illustrations including allTouched comparison.
docs/api/sql/Raster-Accessors/RS_RasterToWorldCoord.md Adds SVG illustration to accessor docs.
docs/api/sql/Raster-Accessors/RS_WorldToRasterCoord.md Adds SVG illustration to accessor docs.
Comments suppressed due to low confidence (1)

docs/api/sql/Raster-Operators/RS_ReprojectMatch.md:56

  • The examples section now ends with an Output: label but no output content after removing the PNG. Either add an output illustration/value (e.g., reuse/extend the new SVGs) or remove the empty Output: section so the page doesn’t look incomplete.

Output:

</details>



---

💡 <a href="/apache/sedona/new/master?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.

@jiayuasu jiayuasu merged commit f478a07 into master Mar 7, 2026
9 checks passed
@jiayuasu jiayuasu deleted the fix/issue-2678-phase12 branch March 9, 2026 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sedona doc should have visuals for individual function to illustrate

2 participants