OpenCV实现Matlab的circshift、fftshift、ifftshift函数

今天挺高兴的，折腾了一天终于搞定了这三个函数，而且在我搜索相关资料的时候，发现不管是百度还是谷歌，都没有人将这三个函数用OpenCV同时实现。感觉挺惊讶的，因为在Matlab代码转OpenCV的时候，特别当用到傅里叶变换时，这类函数应该会很频繁的用到。先不管这些了，这里斗胆来一个全网首发，哈哈。

要实现Matlab的这三个函数，首先可以参考matlab是怎么做的，当在Matlab的命令行输入type circshift.m，可以看到该函数的实现被隐藏了，再看看fftshift和ifftshift，可以发现两者都是调用的circshift。其实理解这三个函数的原理后，就知道fftshift和ifftshift都是circshift的两种特殊情况，所以我们首先实现circshift。

一、circshift的实现

circshift表示的是循环移动，详细说明可以自行百度。它在matlab中的用法是circshift(A,[1 2])，其中A表示待移动矩阵，[1 2]表示矩阵循环向下移动一行，再循环向右移动两行，如下图

看起来很简单，但是写起来并不方便，要是用指针操作这些数据，还是很容易写错的。考虑到既然是用OpenCV，那就用Mat自带的函数来实现。这里用到的是copyTo函数，具体思想看代码就能明白：

void circshift(Mat &out, const Point &delta)
{
    Size sz = out.size();

    // 错误检查
    assert(sz.height > 0 && sz.width > 0);
    // 此种情况不需要移动
    if ((sz.height == 1 && sz.width == 1) || (delta.x == 0 && delta.y == 0))
        return;

    // 需要移动参数的变换，这样就能输入各种整数了
    int x = delta.x;
    int y = delta.y;
    if (x > 0) x = x % sz.width;
    if (y > 0) y = y % sz.height;
    if (x < 0) x = x % sz.width + sz.width;
    if (y < 0) y = y % sz.height + sz.height;


    // 多维的Mat也能移动
    vector planes;
    split(out, planes);

    for (size_t i = 0; i < planes.size(); i++)
    {
        // 竖直方向移动
        Mat tmp0, tmp1, tmp2, tmp3;
        Mat q0(planes[i], Rect(0, 0, sz.width, sz.height - y));
        Mat q1(planes[i], Rect(0, sz.height - y, sz.width, y));
        q0.copyTo(tmp0);
        q1.copyTo(tmp1);
        tmp0.copyTo(planes[i](Rect(0, y, sz.width, sz.height - y)));
        tmp1.copyTo(planes[i](Rect(0, 0, sz.width, y)));

        // 水平方向移动
        Mat q2(planes[i], Rect(0, 0, sz.width - x, sz.height));
        Mat q3(planes[i], Rect(sz.width - x, 0, x, sz.height));
        q2.copyTo(tmp2);
        q3.copyTo(tmp3);
        tmp2.copyTo(planes[i](Rect(x, 0, sz.width - x, sz.height)));
        tmp3.copyTo(planes[i](Rect(0, 0, x, sz.height)));
    }

    merge(planes, out);
}

二、fftshift和ifftshift的实现

参考Matlab中两者的实现，很容易就能写出这两个函数了，代码如下

void fftshift(Mat &out)
{
    Size sz = out.size();
    Point pt(0, 0);
    pt.x = (int)floor(sz.width / 2.0);
    pt.y = (int)floor(sz.height / 2.0);
    circshift(out, pt);
}

void ifftshift(Mat &out)
{
    Size sz = out.size();
    Point pt(0, 0);
    pt.x = (int)ceil(sz.width / 2.0);
    pt.y = (int)ceil(sz.height / 2.0);
    circshift(out, pt);
}

PS

需要注意的是，这里circshift的输入是“Point pt”，pt.x和pt.y分别表示水平方向和竖直方向的移动，与Matlab的输入格式正好相反。另外这几个函数同样适用于一维的Mat，我也和Matlab对比过了，结果完全一致。最后，一些错误检查我可能写的不够，还有函数的实现也没考虑效率因素，所以如果大家有更好的想法，欢迎去我的GitHub留言。