Add gallery examples for cropping and extracting profiles by Amityush-lgtm · Pull Request #263 · sunpy/radiospectra

Amityush-lgtm · 2026-08-06T10:28:23Z

PR Description

This PR adds a new gallery examples demonstrating slicing and cropping using the ndcube API as discussed in #262.

Changes:

Added plot_cropping.py to demonstrate cropping spectrograms and extracting time profiles and line profiles using NDCube's crop() and crop_by_values().

AI Assistance Disclosure

AI tools were used for:

Code generation (e.g., when writing an implementation or fixing a bug)
Test/benchmark generation
Documentation (including examples)
Research and understanding
No AI tools were used

Regardless of AI use, the human contributor remains fully responsible for correctness, design choices, licensing compatibility, and long-term maintainability.

samaloney · 2026-08-09T11:26:11Z

@@ -0,0 +1,89 @@
+"""
+Cropping a WIND/WAVES spectrogram


Suggested change

Cropping a WIND/WAVES spectrogram

Cropping a Spectrogram

as it not specifically to WIND/WAVES that just the data being used for the example

samaloney · 2026-08-09T11:27:04Z

+# Two key methods are available:
+#
+# * `~ndcube.NDCube.crop` — accepts high-level coordinate objects
+#   (e.g. `~astropy.time.Time`).


add SpectralCoord too

Got it, i'll add SpectralCoord :)

samaloney · 2026-08-09T13:01:08Z

+spec = waves_specs[0]
+
+###############################################################################
+# Cropping by time


Hum maybe just Crop and show how to crop using only one axes e.g. Time then the other e.g. SpectralCoord and the using both?

samaloney · 2026-08-09T13:02:06Z

+time_cropped = spec.crop((start_time, None), (end_time, None))
+
+###############################################################################
+# Cropping by frequency


again maybe keep same as above for by time using u.s then frequency as a quantity an then both?

samaloney · 2026-08-09T13:03:14Z

I'm not sure but could maybe fold this into the other example as its an extreme version of cropping to a single axis

Amityush-lgtm · 2026-08-09T19:44:32Z

Ive pushed the suggested changes and updated the examples. While testing locally, the NASA SPDF server is having some issues so fido.search() was getting stuck query, i tried with some other instruments and they are working

samaloney · 2026-08-11T13:03:43Z

Need to megre / rebase main into here or at least update the miniforge3-latest change on the RTD config so the docs build.

Amityush-lgtm · 2026-08-11T13:15:20Z

I have updated the RTD config

Amityush-lgtm · 2026-08-11T20:46:57Z

@samaloney i have brought all the requirements that were added in the Waves Example gallery setup here to check the example here, let me know if this looks right

samaloney · 2026-08-12T11:37:48Z

Yea I guess we should keep the ndcube branch up today with main to avoid having to make the same changes manually

Amityush-lgtm · 2026-08-12T14:14:58Z

That sounds good, but since @hayesla created the ndcube-refactor branch, i dont believe i have permissions to merge main into it,
Would you like me to open a PR from main into ndcube-refactor instead???

samaloney · 2026-08-17T20:16:49Z

@@ -0,0 +1 @@
+Add two new gallery examples (`plot_cropping.py` and `plot_profiles.py`) demonstrating how to slice, crop and extract 1D profiles from a `~radiospectra.spectrogram.GenericSpectrogram` using native `ndcube` methods.


I think this changelog needs to be updated also for the links to work you'll need to link to the build doc rather than the source so e.g.

:doc:`generated/gallery/plot_cropping`

samaloney · 2026-08-17T20:17:42Z

+# Set automodapi to generate files inside the generated directory
+automodapi_toctreedirnm = "generated/api"
+


What's the reason behind this change?

My bad, i think i missed to remove this duplicate while working on the conflict,

samaloney · 2026-08-17T20:23:19Z

+start_time = Time("2017-09-02T15:30:00")
+end_time = Time("2017-09-02T17:00:00")
+
+time_cropped = spec.crop((start_time, None), (end_time, None))


I think should show the equivalent using crop_by_values

I have added small comments in the code to show the equivalent, let me know how it looks

samaloney · 2026-08-17T20:23:51Z

+low_freq = 200 * u.kHz
+high_freq = 600 * u.kHz
+
+freq_cropped = spec.crop_by_values((None, low_freq), (None, high_freq))


kinda same here show the equivalent using crop

samaloney · 2026-08-17T20:24:08Z

+low_freq_coord = SpectralCoord(200 * u.kHz)
+high_freq_coord = SpectralCoord(600 * u.kHz)
+
+both_cropped = spec.crop((start_time, low_freq_coord), (end_time, high_freq_coord))


again maybe show the equivalent using crop_by_values

Amityush-lgtm · 2026-08-18T08:19:24Z

Im looking into figure tests failure and it seems that the hashes have changed, i dont know why maybe because of ndcube, so i will update them and also check for the right version of mpl_animators

Cadair · 2026-08-19T16:19:00Z

+end_time = Time("2017-09-02T17:00:00")
+
+time_cropped = spec.crop((start_time, None), (end_time, None))
+# Or equivalently using crop_by_values (which uses the WCS lookup table units of seconds):


you need to be very strict with line length on the examples or it will vanish out of the code cell.

Ill reduce it a bit

Hermanlrx

Just add colour bars when you find time! Otherwise lgtm

Amityush-lgtm added 3 commits August 6, 2026 14:41

Add gallery example for cropping

e313a1b

Add gallery example for extracting profiles

631d26b

Adding changelog

37942b3

samaloney reviewed Aug 9, 2026

View reviewed changes

Folding both examples into one and improving the plots

816cebc

Amityush-lgtm requested a review from samaloney August 11, 2026 12:44

Update RTD config

99bd91e

adding RTD config to check the example

3866773

removing :inherited-members

37700e2

Amityush-lgtm added 2 commits August 18, 2026 01:33

resolving merge conflicts

a9781ce

Merge branch 'ndcube-refactor' into slicing-examples

7b79303

samaloney reviewed Aug 17, 2026

View reviewed changes

Amityush-lgtm added 2 commits August 18, 2026 02:48

Applying suggestions from @samaloney

0a49f07

fixing path for doc link

aed8cc0

Amityush-lgtm added 3 commits August 18, 2026 13:57

updating figure test hashes and mpl_animator version

937eb0d

fix hashes

08d0ab0

Merge branch 'ndcube-refactor' into slicing-examples

f150d7c

Cadair reviewed Aug 19, 2026

View reviewed changes

hayesla approved these changes Aug 19, 2026

View reviewed changes

Hermanlrx reviewed Aug 19, 2026

View reviewed changes

Reduce line lengths in example

8662a32

samaloney merged commit 9c9324a into sunpy:ndcube-refactor Aug 20, 2026
46 of 47 checks passed

		@@ -0,0 +1 @@
		Add two new gallery examples (`plot_cropping.py` and `plot_profiles.py`) demonstrating how to slice, crop and extract 1D profiles from a `~radiospectra.spectrogram.GenericSpectrogram` using native `ndcube` methods.

		# Set automodapi to generate files inside the generated directory
		automodapi_toctreedirnm = "generated/api"

Uh oh!

Uh oh!

Conversation

Amityush-lgtm commented Aug 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Description

Changes:

AI Assistance Disclosure

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Amityush-lgtm commented Aug 9, 2026

Uh oh!

samaloney commented Aug 11, 2026

Uh oh!

Amityush-lgtm commented Aug 11, 2026

Uh oh!

Amityush-lgtm commented Aug 11, 2026

Uh oh!

samaloney commented Aug 12, 2026

Uh oh!

Amityush-lgtm commented Aug 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Amityush-lgtm commented Aug 18, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Hermanlrx left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Amityush-lgtm commented Aug 6, 2026 •

edited

Loading

Amityush-lgtm commented Aug 12, 2026 •

edited

Loading