Search code examples
c++ffthalide

How to do a forward followed by inverse FFT in Halide


I am currently trying to do a forward followed by a reverse fft, however it doesn't seem to be working. The FFT I am using is the one found in fft.cpp (Halide/apps/fft). My goal currently is just trying to save a 16x16 tile of an image. This 16x16 tile should be forward followed by reverse fft of a 16x16 tile. My problem is that my output buffer has values of 9000 for some reason. Here is my code:

//A program to make an fft of an image both ways (r2c, c2r)
//Plan of action:
//1.)Load in image into buffer using load_image (uint8)
//2.)Then cast it to a float
//3.)Then convert float buffer to a function
//4.)Then set fft2d settings
//5.)Then call real to complex
//6.)Then call complex to real
//7.)Then realize it to an output buffer
//8.)Then save the image

#include <stdio.h>
#include "Halide.h"
#include "fft.h"
#include "halide_image_io.h"

using namespace Halide;
using namespace Halide::Tools;
using namespace std;


template <typename Type1, typename Type2>
void compare(Halide::Buffer<Type1> org, Halide::Buffer<Type2> other);

Var x{"x"}, y{"y"}, c{"c"};
Func real_result;
ComplexFunc complex_result("Complex_Result");
int colour_channel_to_fft = 1; //or 1 , or 2
int tileSize = 16;

int main(){
    Halide::Buffer<uint8_t> unsignedIntTempBuffer = load_image("rgb.png");

    //2.) Then cast it to a float
    Func uint8_tToFloat;
    uint8_tToFloat(x,y,c) = Halide::cast<float>(unsignedIntTempBuffer(x,y,c));

    Halide::Buffer<float> input;
    input = uint8_tToFloat.realize(unsignedIntTempBuffer.width(),unsignedIntTempBuffer.height(),unsignedIntTempBuffer.channels()); //Input becomes a float buffer

    //3.)Then convert float buffer to a greysacle function
    Func in;
    in(x,y) = input(x,y,colour_channel_to_fft); //Third parameter states which RGB grey scale to use

    Halide::Buffer<float> temp;
    temp = in.realize(input.width(), input.height());

    //4.)Then set fft2d settings - the current setting are defaulted
    Fft2dDesc desc;
    desc.gain = 1.0f;
    desc.vector_width = 0;
    desc.parallel = false;

    //5.)Then call real to complex
    complex_result = fft2d_r2c(in, tileSize, tileSize,get_jit_target_from_environment(), desc);    //Max dimension size of 767

    //Load the complex result into the complexBuffer
    Halide::Buffer<float> complexBuffer;
    complexBuffer = complex_result.realize();

    ComplexFunc cmplxIn;
    cmplxIn(x, y) = ComplexExpr(re(complexBuffer(x, y)), im(complexBuffer(x, y))); //IN GENERATOR THEY USE CHANNEL 1 & 0? Not possible due to us only using one channel for real input
    //6.)Then call complex to real
    real_result = fft2d_c2r(cmplxIn,tileSize,tileSize,get_jit_target_from_environment(),desc);
    Halide::Buffer<float>output;
    output = real_result.realize(); // as output(x,y,c) = re(complex_result(x,y)); doesn't work (seg fault)

    Func floatToUInt8;
    floatToUInt8(x,y,c) = Halide::cast<uint8_t>(output(x,y));

    Halide::Buffer<uint8_t> finalOutput = floatToUInt8.realize(tileSize, tileSize, input.channels());//, input.channels());
    save_image(finalOutput, "forwardThenReverseFFT.png");
    cout << "Success" << endl;
    //Func -> Buffer must use a realize
}

template <typename Type1, typename Type2>
void compare(Halide::Buffer<Type1> org, Halide::Buffer<Type2> other){
    string channel = "";
    if (colour_channel_to_fft == 0) channel = "Red";
    else if (colour_channel_to_fft == 1) channel = "Green";
    else if (colour_channel_to_fft == 2) channel = "Blue";
    else cout<< "You have chosen an incorrect channel";
    std::cout << "Original: " << std::endl << channel << " channel value at (0,0) = " << org(3,3) << std::endl;
    std::cout << "FFTd: " << std::endl << channel << " channel value at (0,0) = " << other(0,0) << std::endl << std::endl;
}

The image that gets saved is: https://i.sstatic.net/9Rqtm.png Which appears to have no correlation to the original image on any channels.

Any ideas as to what I am doing wrong?


Solution

  • SleuthEye is on the right track. I think part of the issue is that the result of fft2d_r2c is a tuple-valued function (see https://halide-lang.org/tutorials/tutorial_lesson_13_tuples.html). ComplexExpr/ComplexFunc are wrappers around Tuple and Tuple-valued Funcs. It's a bit surprising that it even compiles/runs at all to assign a realization of this to a Halide::Buffer.

    Another issue is that realize needs a size. (You might be able to get away without this because FFTs have requirements on the bounds of the output.) For FFTs, it's a bit tricky, because the complex domain is only partially defined. For a 16x16 FFT, the complex domain is 16x9, the rest of the domain can be computed by exploiting the conjugate symmetry property of DFTs. (https://github.com/halide/Halide/blob/b465318a583ff58114ac63ecd8125ca7e648ae35/apps/fft/fft.h#L55-L56).

    I suspect something like this is what you need:

    //Load the complex result into the complexBuffer
    Halide::Realization complexBuffer = complex_result.realize(16, 9);
    Halide::Buffer<float> realPart = complexBuffer[0];
    Halide::Buffer<float> imagPart = complexBuffer[1];
    
    // Now construct the complex part for `fft2d_c2r` from these two buffers.
    

    I think that if you try to realize (go to/from Halide in the complex domain), things will be a bit more difficult than necessary. Normally, if you use fft2d_r2c, do some work, and then use fft2d_c2r, all in one pipeline, Halide's bounds inference will mean that you don't need to worry too much about the odd bounds of the DFT domain.