Files
leonarski_fandClaude Opus 5.5 01017c4bb7 FFTW removed: every CPU FFT is pocketfft's (common/CpuFFT)
FFTW is no longer fetched, built or linked - not even by jfjoch_test. The
JFJOCH_USE_FFTW define and its #ifdefs are gone: the CPU FFT indexer, the
viewer's FFT chart and the rest are always built. The test that checked
pocketfft against FFTW now checks it against a direct double-precision DFT
(forward) and a round trip (backward), on the same shapes.

The user-facing name stays: -X FFTW, the OpenAPI enum value, the CBOR and
HDF5 strings - the CPU FFT indexer is still called FFTW, only the
implementation changed; the CLI page says so. Under MSVC pocketfft is told
explicitly to run scalar (it already decides so itself: its vector code needs
the GCC/Clang vector extension).

Licences: licenses/fftw.txt, its COLLECT.sh line, the THIRD_PARTY_NOTICES row
and note, and the viewer's embedded copy removed; docs/THIRD_PARTY_NOTICES.md
regenerated with update_version.sh's own sed block. CLAUDE.md and the docs
that named FFTW as the library now name pocketfft.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UqXYdJDrM65gxsCn2PrbfK
2026-11-16 06:11:40 +01:00

143 lines
5.8 KiB
C++

// SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
// SPDX-License-Identifier: GPL-3.0-only
#include <catch2/catch_all.hpp>
#include <algorithm>
#include <cmath>
#include <complex>
#include <random>
#include <vector>
#include "../common/CpuFFT.h"
#include "../image_analysis/structure_refinement/ModelFFT.h"
// pocketfft (common/CpuFFT) on the shapes and layouts the call sites use, against a direct DFT in double
// precision: the forward transforms to float rounding, the backward ones by a round trip (an unnormalised
// forward + backward pair gives the input times the number of points).
namespace {
std::vector<float> Random(size_t n, unsigned seed) {
std::mt19937 rng(seed);
std::normal_distribution<float> g(0.0f, 1.0f);
std::vector<float> v(n);
for (auto &x : v)
x = g(rng);
return v;
}
// Largest difference relative to the largest value of the reference.
template <typename T, typename U>
double RelativeError(const std::vector<T> &a, const std::vector<U> &ref) {
REQUIRE(a.size() == ref.size());
double diff = 0, scale = 0;
for (size_t i = 0; i < a.size(); i++) {
diff = std::max(diff, std::abs(std::complex<double>(a[i]) - std::complex<double>(ref[i])));
scale = std::max(scale, std::abs(std::complex<double>(ref[i])));
}
return diff / scale;
}
// Forward DFT of a row-major array along every axis, computed directly, in double precision.
std::vector<std::complex<double>> DirectDFT(const std::vector<size_t> &shape, const std::vector<float> &in) {
std::vector<std::complex<double>> a(in.begin(), in.end());
size_t stride = a.size();
for (size_t n : shape) {
stride /= n;
std::vector<std::complex<double>> line(n);
for (size_t base = 0; base < a.size(); base++) {
if ((base / stride) % n != 0)
continue; // not the first element of a line along this axis
for (size_t k = 0; k < n; k++) {
std::complex<double> s = 0;
for (size_t j = 0; j < n; j++)
s += a[base + j * stride] * std::polar(1.0, -2.0 * M_PI * static_cast<double>(j * k % n) / n);
line[k] = s;
}
for (size_t k = 0; k < n; k++)
a[base + k * stride] = line[k];
}
}
return a;
}
// The half (n/2 + 1 values) of the last axis that a real transform keeps.
std::vector<std::complex<double>> HalfLastAxis(const std::vector<size_t> &shape,
const std::vector<std::complex<double>> &full) {
const size_t n = shape.back(), nc = n / 2 + 1;
std::vector<std::complex<double>> half;
for (size_t i = 0; i < full.size(); i++)
if (i % n < nc)
half.push_back(full[i]);
return half;
}
std::vector<float> Scaled(const std::vector<float> &v, double s) {
std::vector<float> r(v.size());
for (size_t i = 0; i < v.size(); i++)
r[i] = static_cast<float>(v[i] * s);
return r;
}
} // namespace
TEST_CASE("CpuFFT_BatchedR2CMatchesDirectDFT", "[fft]") {
// The FFT indexer's histograms: one transform per direction; 3142 = 2 x 1571 is a real length.
for (size_t n : {3142, 3150, 1024}) {
const size_t howmany = 5;
const std::vector<float> in = Random(howmany * n, n);
std::vector<std::complex<float>> ours(howmany * (n / 2 + 1));
cpu_fft::R2C({howmany, n}, {1}, in.data(), ours.data());
// DirectDFT over the batch axis too would mix the lines: transform each line on its own.
std::vector<std::complex<double>> ref;
for (size_t i = 0; i < howmany; i++) {
const std::vector<float> line(in.begin() + i * n, in.begin() + (i + 1) * n);
const auto r = HalfLastAxis({n}, DirectDFT({n}, line));
ref.insert(ref.end(), r.begin(), r.end());
}
CHECK(RelativeError(ours, ref) < 1e-5);
}
}
TEST_CASE("CpuFFT_2DRoundTrip", "[fft]") {
// The beam-centre search: a 2D r2c and c2r on a 2-3-5-7-smooth padded size.
const std::vector<size_t> shape = {210, 336};
const std::vector<float> in = Random(shape[0] * shape[1], 1);
std::vector<std::complex<float>> ours(shape[0] * (shape[1] / 2 + 1));
cpu_fft::R2C(shape, {0, 1}, in.data(), ours.data());
CHECK(RelativeError(ours, HalfLastAxis(shape, DirectDFT(shape, in))) < 1e-5);
std::vector<float> back(in.size());
cpu_fft::C2R(shape, {0, 1}, ours.data(), back.data());
CHECK(RelativeError(back, Scaled(in, static_cast<double>(in.size()))) < 1e-5);
}
TEST_CASE("CpuFFT_3DRoundTrip", "[fft]") {
// The model maps (u fastest, w halved) and the tNCS Patterson (row-major, last axis halved) are both a
// row-major 3D transform halving the last axis; an odd length and a factor 7 included.
const std::vector<size_t> shape = {70, 45, 54};
const std::vector<float> in = Random(shape[0] * shape[1] * shape[2], 2);
std::vector<std::complex<float>> ours(shape[0] * shape[1] * (shape[2] / 2 + 1));
cpu_fft::R2C(shape, {0, 1, 2}, in.data(), ours.data());
CHECK(RelativeError(ours, HalfLastAxis(shape, DirectDFT(shape, in))) < 1e-5);
std::vector<float> back(in.size());
cpu_fft::C2R(shape, {0, 1, 2}, ours.data(), back.data());
CHECK(RelativeError(back, Scaled(in, static_cast<double>(in.size()))) < 1e-5);
}
TEST_CASE("CpuFFT_MapToFPhiInParallelMatchesMapToFPhi", "[fft]") {
gemmi::Grid<float> map;
map.unit_cell.set(60, 50, 40, 90, 90, 90);
map.spacegroup = gemmi::find_spacegroup_by_name("P1");
map.set_size(60, 50, 40);
map.data = Random(map.data.size(), 3);
const int reach = 12;
const gemmi::FPhiGrid<float> ref = CropHalfL(MapToFPhi(map), reach);
for (size_t nthreads : {1, 4}) {
const gemmi::FPhiGrid<float> ours = MapToFPhiInParallel(map, reach, nthreads);
CHECK(RelativeError(ours.data, ref.data) < 1e-5);
}
}