Skip to content

DOC: Update FFTPadImageFilter prime factor doc for PocketFFT #6574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
blowekamp wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −2
Draft

DOC: Update FFTPadImageFilter prime factor doc for PocketFFT #6574

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Modules/Filtering/FFT/include/itkFFTPadImageFilter.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@ class ITK_TEMPLATE_EXPORT FFTPadImageFilter : public PadImageFilterBase<TInputIm
* Set/Get the greatest prime factor allowed on the size of the padded image.
*
* The filter increases the dimensional sizes of the image to reach a size with the greatest
* prime factor smaller or equal to the specified value. The default values is
* obtained from the ForwardFFTImageFilter, which is 13 for FFTW,
* prime factor smaller or equal to the specified value. The default value is
* obtained from the ForwardFFTImageFilter, which is 13 for FFTW, 11 for PocketFFT,
* and 5 for VNL.
Comment on lines +85 to 86

@hjmjohnson hjmjohnson Jul 9, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The VNL/Temperton backend was removed; the deprecated Vnl* aliases derive from the PocketFFT filters and inherit 11, so "5 for VNL" is no longer reachable.

Suggested change
* obtained from the ForwardFFTImageFilter, which is 13 for FFTW, 11 for PocketFFT,
* and 5 for VNL.
* obtained from the ForwardFFTImageFilter, which is 13 for FFTW (7 with cuFFTW)
* and 11 for PocketFFT.

*
* A greatest prime factor of 2 produce a size which is a power of 2, and thus

@hjmjohnson hjmjohnson Jul 9, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Grammar, and the next line's "is suitable for vnl base fft filters." is also stale (VNL backend removed) — it is just outside this hunk, so please fold it in manually, e.g. end the sentence at "power of 2." and drop the VNL clause.

Suggested change
* A greatest prime factor of 2 produce a size which is a power of 2, and thus
* A greatest prime factor of 2 produces a size which is a power of 2, and thus

Expand Down
Loading