python numpy实现PixelShuffle及其逆变换（depth_to_space，space_to_depth）

╰+哭是因爲堅強的太久メ 2022-10-25 04:43 220阅读 0赞

### 文章目录 ###

*  PixelShuffle简介
 *   *  作用与来源
     *  特点
 *  PixelShuffle的原理
 *   *  depth\_to\_space
     *  space\_to\_depth
 *  numpy的reshape和transpose简介
 *  numpy实现PixelShuffle
 *   *  PixelShuffle的逆变换（space\_to\_depth）
     *  PixelShuffle（depth\_to\_space）
     *  正式代码

本文档代码使用的工具版本：  
PyTorch 1.6  
TensorFlow 2.1

本文档除了最后的正式实现代码之外，所有的示例都默认上/下采样的scale factor等于2。

# PixelShuffle简介 #

## 作用与来源 ##

PixelShuffle（PyTorch中的方法）的作用主要是增大特征图的空间分辨率，将Tensor的shape从 ( N , C ∗ s 2 , H , W ) (N, C\*s^2, H, W) (N,C∗s2,H,W)变为 ( N , C , H ∗ s , W ∗ s ) (N, C, H\*s, W\*s) (N,C,H∗s,W∗s)，其中  s s s （scale factor）必需是整数，所以它只能实现上采样，而不能做到下采样。该方法一定程度上可以替代Upsample，常常用在图像超分辨率（super resolution）中。

在TensorFlow中，相应的方法叫做depth\_to\_space（感觉这个名字起得更好一些），并且TF中有可以实现逆变换功能（下采样）的space\_to\_depth。

实际上该方法正是在一篇超分文章（ESPCN）中被提出：  
[Real-Time Single Image and Video Super-Resolution Using an Efficient Sub-Pixel Convolutional Neural Network][]

在这篇文章中，作者将这种上采样方法称为sub-pixel convolution，示意图如下：  
![图1][1]

图1. ESPCN - sub-pixel convolution

## 特点 ##

稍后ESPCN的作者还写了一篇解释性的文章：  
[Is the deconvolution layer the same as a convolutional layer?][Is the deconvolution layer the same as a convolutional layer]

该文章大概的意思是，sub-pixel convolution与transposed convolution效果等同，但是前者无需参数进行学习，只需要对Tensor进行重排列即可完成，所以可提升网络运行**效率**。

另外有一篇很好的解释性文档（[Deconvolution and Checkerboard Artifacts][]）讨论了神经网络生成的图像中所存在的棋盘格效应（chekerboard artifacts）。从这个角度来看，transposed convolution的效果可能甚至还不如sub-pixel convolution。因为通常transposed convolution存在overlap，而上述文档认为这个overlap就是导致棋盘格效应的原因，而sub-pixel convolution则可以天然避免overlap的问题。

所以总的来说，sub-pixel convolution效率和效果均不错，现在已经大量用在超分相关的论文中，当然其他需要上采样的地方也有不少应用。

# PixelShuffle的原理 #

## depth\_to\_space ##

前面讲过，Pytorch中的PixelShuffle相当于TensorFlow中的depth\_to\_space。

使用PyTorch写一个`upscale_factor = 2`的测试例子：

import torch
    
    a = torch.arange(36).reshape([1, 4, 3, 3])
    b = torch.pixel_shuffle(a, 2)
    print(a)
    print(b)

TensorFlow可以使用如下代码写出同上的例子。  
（有两个注意点，1、dtype要设置成float型，2、data\_format要设置成“NCHW”）

import tensorflow as tf
    
    a = tf.range(0, 36, dtype='float')
    b = tf.reshape(a, [1, 4, 3, 3])
    c = tf.nn.depth_to_space(b, block_size=2, data_format="NCHW")
    print(b)
    print(c)

上述例子的结果可用下图表示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JieTE5ODc_size_16_color_FFFFFF_t_70_pic_center]

图2. 上采样系数为2情况下的PixelShuffle示意图

上图中，左侧是4个3\*3的特征图，经PixelShuffle后，变成右侧一个1通道6\*6的特征图，Tensor的size在PixelShuffle前后的变化根据定义很容易理解。需要注意的地方是数值的重排列方式，4个特征图可以有很多种方式进行重排列（比如图3），但为什么要按照图2所示的方式来做？

![在这里插入图片描述][20210130231332227.png_pic_center]

图3. 另一种数值重排列方式

结合PixelShuffle提出时的背景：超分，以及一些我们对卷积神经网络的主观认识，有以下一些原因：

*  特征图含有空间信息，原始图片中的内容之间的空间相对位置关系在特征图中往往得以一定程度的保持。比如一张人脸图像经过几次卷积后，不会发生眼睛跑到下巴的地方，嘴巴跑到眉毛的地方等情况，别的不说，感受野它也不允许。
 *  在不同的特征图中，相同空间位置上的数值可能含有相近的空间信息。这是一个想当然的主观认识，也可以看作是上一条原因的推论。实际上如果我们把特征出画出来看一看的话会发现，事实情况也确实如此，关于此点可参考“[Pytorch可视化特征图][Pytorch]”，看一看最后面几张图就好了。
 *  特征图的空间信息不仅可以分布在宽、高维度上，也可以适当分布在通道维度上。在一些自编码类型的语义分割网络中有时可以看到这样的情况，特征图都已经被pooling成一个 ( N , C , 1 , 1 ) (N, C, 1, 1) (N,C,1,1)的向量了，仍然可以通过上采样一步步得到最后的mask。这就说明在C维度上可以一定程度地保有空间信息。
 *  含有相近空间信息的数值，在重排列时应当放在一起，不然会给网络接下来的学习带来障碍。这也是一个比较主观的认识，比如对于人脸来讲，如果相邻的空间位置既有眼睛的特征又有嘴巴的特征，那想想就感觉不太对劲。
 *  超分的最终结果需要极其严格地保持空间相对位置关系。这是很显然的，就不多说了。

所以在图2中，相同颜色，也就是在不同特征图中处于相同空间位置的数值，应该在重排列的时候将其放在一起（相邻的位置）。而至于说是以行优先排列还是以列优先排列，这就无所谓了，因为C/CPP以及很多GPU编程语言都是以行优先的，所以各个框架的实现也都是行优先。

## space\_to\_depth ##

PixelShuffle的**逆变换**应当遵循同样的原则。

PyTorch没有PixelShuffle的逆变换功能。TensorFlow有，示例如下，`b`经depth\_to\_space变为`c`，而`c`又经space\_to\_depth变为`d`，打印出来容易发现`b与d`相同。

import tensorflow as tf
    
    a = tf.range(0, 36, dtype='float')
    b = tf.reshape(a, [1, 4, 3, 3])
    c = tf.nn.depth_to_space(b, block_size=2, data_format="NCHW")
    print(b)
    print(c)
    
    d = tf.nn.space_to_depth(c, block_size=2, data_format="NCHW")
    print(d)

# numpy的reshape和transpose简介 #

根据PixelShuffle的原理，最简单的实现方式就是暴力写循环，通过赋值的方式进行实现，然而在python中写循环绝对是一种极其低效的选择。事实上我们完全可以利用numpy的reshape和transpose进行实现，不必写任何一个循环，这样效率会高得多。

reshape的作用是改变数组的形状，比如说把一个形状为 ( 1 × 24 ) (1 \\times 24) (1×24)的数组改成 ( 2 × 3 × 4 ) (2 \\times 3 \\times 4) (2×3×4)的形状。

transpose的作用是调整数组的维度（axis）顺序。比如对于二维数组而言，对调维度顺序就是我们熟悉的矩阵转置。而transpose可以对更高维度的数组进行调整。

reshape和transpose都是非常高效的算子，究其原因，是因为二者均没有在内存中重新排列数据，只是对数据的shape或strides等信息进行了改变。详情可以参考“[numpy的reshape和transpose机制解释][numpy_reshape_transpose]”

# numpy实现PixelShuffle #

先讲逆变换，再讲正变换。逆变换相对容易理解一些。

## PixelShuffle的逆变换（space\_to\_depth） ##

import numpy as np
    
    a = np.arange(36).reshape(6, 6)
    print(a)  # ==>
    # [[ 0 1 2 3 4 5]
    # [ 6 7 8 9 10 11]
    # [12 13 14 15 16 17]
    # [18 19 20 21 22 23]
    # [24 25 26 27 28 29]
    # [30 31 32 33 34 35]]
    
    b = a.reshape([3, 2, 6])
    print(b)  # ==>
    # [[[ 0 1 2 3 4 5]
    # [ 6 7 8 9 10 11]]
    #
    # [[12 13 14 15 16 17]
    # [18 19 20 21 22 23]]
    #
    # [[24 25 26 27 28 29]
    # [30 31 32 33 34 35]]]
    print(b[0, :, :])  # ==>
    # [[ 0 1 2 3 4 5]
    # [ 6 7 8 9 10 11]]
    
    c = a.reshape([6, 3, 2])
    print(c[:, 0, :])  # ==>
    # [[ 0 1]
    # [ 6 7]
    # [12 13]
    # [18 19]
    # [24 25]
    # [30 31]]
    
    d = a.reshape([3, 2, 3, 2])
    print(d[0, :, 0, :])  # ==>
    # [[0 1]
    # [6 7]]
    print(d[0, :, 1, :])  # ==>
    # [[2 3]
    # [8 9]]

如果不使用索引切片，而是直接使用print(c )，print(d)来查看数组的话，打印出来的数组形态对于当前问题的理解不是太友好。

所以就画了图4，图4这些花花绿绿的颜色是告诉大家，reshape之后的数组应当顺着shape=3的维度去看，这样就比较容易理解。当我们将数组reshape(\[3, 2, 3, 2\])之后，顺着两个shape=3的维度去看，数组被分成了9个2\*2的方块，然后我们可以采用两种思路理解接下来要做的事：

1.  每个2\*2的方块各自在通道维度上拉平，于是就变成了通道数等于4，空间尺寸3\*3的数组；
2.  从每个2\*2的方块的特定位置上抽取一个数字，比如都位于左上角的\[0, 2, 4\]…，这样就能形成4个3\*3的数组。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JieTE5ODc_size_16_color_FFFFFF_t_70_pic_center 1]

图4. 6\*6矩阵的三种reshape方式

下面就是PixelShuffle逆变换的流程：

*  reshape成 ( n , 2 , n , 2 ) (n, 2, n, 2) (n,2,n,2)的形状。此处n=3，为变换后的空间维度的shape值；2表示scale factor。
 *  transpose调整维度顺序，将两个n放在一起，两个2放在一起，放在前面或者放在后面均可，本例按照PyTorch的风格放在了前面。
 *  再次通过reshape将两个shape=2的维度拉平。

怎么理解打印出来的`d`呢？  
下面数组`d`包含4个3\*3块，每个对应于图4中6\*6数组以stride=2抽样出来的一个子数组。

import numpy as np
    
    a = np.arange(36).reshape(6, 6)
    b = a.reshape([3, 2, 3, 2])
    c = b.transpose([1, 3, 0, 2])
    d = c.reshape([-1, 3, 3])
    print(d)  # ==>
    # [[[ 0 2 4]
    # [12 14 16]
    # [24 26 28]]
    #
    # [[ 1 3 5]
    # [13 15 17]
    # [25 27 29]]
    #
    # [[ 6 8 10]
    # [18 20 22]
    # [30 32 34]]
    #
    # [[ 7 9 11]
    # [19 21 23]
    # [31 33 35]]]

## PixelShuffle（depth\_to\_space） ##

下面例子对应于图2。由于图2的例子我们在前面使用PyTorch写过，所以对比PyTorch的结果页可以知道下面的结果是正确的。

PixelShuffle的流程只要把逆变换的流程反过来即可：

*  将数组reshape成 ( 2 , 2 , n , n ) (2, 2, n, n) (2,2,n,n)的形状
 *  通过transpose将数组调整为 ( n , 2 , n , 2 ) (n, 2, n, 2) (n,2,n,2)的形式
 *  再次通过reshape将数组调整为 ( 2 ∗ n , 2 ∗ n ) (2\*n, 2\*n) (2∗n,2∗n)的形状。

import numpy as np
    
    a = np.arange(36).reshape([4, 3, 3])
    b = a.reshape([2, 2, 3, 3])
    c = b.transpose([2, 0, 3, 1])
    d = c.reshape([6, 6])
    
    print(a)  # ==>
    # [[[ 0 1 2]
    # [ 3 4 5]
    # [ 6 7 8]]
    #
    # [[ 9 10 11]
    # [12 13 14]
    # [15 16 17]]
    #
    # [[18 19 20]
    # [21 22 23]
    # [24 25 26]]
    #
    # [[27 28 29]
    # [30 31 32]
    # [33 34 35]]]
    
    print(d)  # ==>
    # [[ 0 9 1 10 2 11]
    # [18 27 19 28 20 29]
    # [ 3 12 4 13 5 14]
    # [21 30 22 31 23 32]
    # [ 6 15 7 16 8 17]
    # [24 33 25 34 26 35]]

## 正式代码 ##

上面我们使用单通道的数组进行示例，以方便画图和理解。实际上待变换的数组通常不是单通道的，所以还需要一些额外的注意事项。

*  通道维度上距离远近不代表空间距离上的远近，所以对通道进行reshape的时候，无论是reshape成 ( n e w \_ c h , s , s ) (new\\\_ch, s, s) (new\_ch,s,s)，还是reshape成 ( s , s , n e w \_ c h ) (s, s, new\\\_ch) (s,s,new\_ch)都可以，其中s代表scale factor。PyTorch风格使用的是前者，TensorFlow风格使用的是后者。
 *  PyTorch风格表示相邻的 s ∗ s s\*s s∗s个通道组合在一起进行upsample，从而组合成一个新的通道（PixelShuffle）；或者将一个通道拆分成相邻的 s ∗ s s\*s s∗s个通道（PixelShuffle逆变换）。
 *  TensorFlow风格表示每间隔 c h / ( s ∗ s ) ch/(s\*s) ch/(s∗s)个通道抽1个，而后将其组合成一个通道（depth\_to\_space）；或者将一个通道拆分成间隔为 c h / ( s ∗ s ) ch/(s\*s) ch/(s∗s)的多个通道（space\_to\_depth）。
 *  transpose时候，两个`scale_factor`的相对顺序需保持不变，并且分别放置于`height`和`width`后面（PixelShuffle）；或从`height`和`width`后面提取到一起（PixelShuffle逆变换）。

下面是PyTorch风格的实现：

""" PyTorch style implementation """
    import numpy as np
    import torch
    import torch.nn.functional as F
    
    
    def pixel_shuffle(tensor, scale_factor):
        """ Implementation of pixel shuffle using numpy Parameters: ----------- tensor: input tensor, shape is [N, C, H, W] scale_factor: scale factor to up-sample tensor Returns: -------- tensor: tensor after pixel shuffle, shape is [N, C/(s*s), s*H, s*W], where s refers to scale factor """
        num, ch, height, width = tensor.shape
        if ch % (scale_factor * scale_factor) != 0:
            raise ValueError('channel of tensor must be divisible by '
                             '(scale_factor * scale_factor).')
    
        new_ch = ch // (scale_factor * scale_factor)
        new_height = height * scale_factor
        new_width = width * scale_factor
    
        tensor = tensor.reshape(
            [num, new_ch, scale_factor, scale_factor, height, width])
        # new axis: [num, new_ch, height, scale_factor, width, scale_factor]
        tensor = tensor.transpose([0, 1, 4, 2, 5, 3])
        tensor = tensor.reshape([num, new_ch, new_height, new_width])
        return tensor
    
    
    def pixel_shuffle_inv(tensor, scale_factor):
        """ Implementation of inverted pixel shuffle using numpy Parameters: ----------- tensor: input tensor, shape is [N, C, H, W] scale_factor: scale factor to down-sample tensor Returns: -------- tensor: tensor after pixel shuffle, shape is [N, (s*s)*C, H/s, W/s], where s refers to scale factor """
        num, ch, height, width = tensor.shape
        if height % scale_factor != 0 or width % scale_factor != 0:
            raise ValueError('height and widht of tensor must be divisible by '
                             'scale_factor.')
    
        new_ch = ch * (scale_factor * scale_factor)
        new_height = height // scale_factor
        new_width = width // scale_factor
    
        tensor = tensor.reshape(
            [num, ch, new_height, scale_factor, new_width, scale_factor])
        # new axis: [num, ch, scale_factor, scale_factor, new_height, new_width]
        tensor = tensor.transpose([0, 1, 3, 5, 2, 4])
        tensor = tensor.reshape([num, new_ch, new_height, new_width])
        return tensor
    
    
    if __name__ == '__main__':
        # numpy computation
        a = np.arange(2 * 20 * 7 * 7).reshape([2, 20, 7, 7])
        b = pixel_shuffle(a, scale_factor=2).astype(np.int32)
        c = pixel_shuffle_inv(b, scale_factor=2).astype(np.int32)
    
        # torch computation
        a_torch = torch.arange(2 * 20 * 7 * 7).reshape([2, 20, 7, 7])
        b_torch = F.pixel_shuffle(a_torch, upscale_factor=2)
    
        a_torch = a_torch.numpy().astype(np.int32)
        b_torch = b_torch.numpy().astype(np.int32)
    
        # check
        print(np.all(b == b_torch))
        print(np.all(c == a_torch))

接下来是TensorFlow风格的实现：

""" TensorFlow style implementation """
    import numpy as np
    import tensorflow as tf
    
    
    def depth_to_space(tensor, scale_factor):
        """ Implementation of depth to space using numpy Parameters: ----------- tensor: input tensor, shape is [N, C, H, W] scale_factor: scale factor to up-sample tensor Returns: -------- tensor: tensor after pixel shuffle, shape is [N, C/(s*s), s*H, s*W], where s refers to scale factor """
        num, ch, height, width = tensor.shape
        if ch % (scale_factor * scale_factor) != 0:
            raise ValueError('channel of tensor must be divisible by '
                             '(scale_factor * scale_factor).')
    
        new_ch = ch // (scale_factor * scale_factor)
        new_height = height * scale_factor
        new_width = width * scale_factor
    
        tensor = tensor.reshape(
            [num, scale_factor, scale_factor, new_ch, height, width])
        # new axis: [num, new_ch, height, scale_factor, width, scale_factor]
        tensor = tensor.transpose([0, 3, 4, 1, 5, 2])
        tensor = tensor.reshape([num, new_ch, new_height, new_width])
        return tensor
    
    
    def space_to_depth(tensor, scale_factor):
        """ Implementation of space to depth using numpy Parameters: ----------- tensor: input tensor, shape is [N, C, H, W] scale_factor: scale factor to down-sample tensor Returns: -------- tensor: tensor after pixel shuffle, shape is [N, (s*s)*C, H/s, W/s], where s refers to scale factor """
        num, ch, height, width = tensor.shape
        if height % scale_factor != 0 or width % scale_factor != 0:
            raise ValueError('height and widht of tensor must be divisible by '
                             'scale_factor.')
    
        new_ch = ch * (scale_factor * scale_factor)
        new_height = height // scale_factor
        new_width = width // scale_factor
    
        tensor = tensor.reshape(
            [num, ch, new_height, scale_factor, new_width, scale_factor])
        # new axis: [num, scale_factor, scale_factor, ch, new_height, new_width]
        tensor = tensor.transpose([0, 3, 5, 1, 2, 4])
        tensor = tensor.reshape([num, new_ch, new_height, new_width])
        return tensor
    
    
    if __name__ == '__main__':
        a = np.arange(2 * 20 * 7 * 7).reshape([2, 20, 7, 7])
        b = depth_to_space(a, scale_factor=2).astype(np.int32)
        c = space_to_depth(b, scale_factor=2).astype(np.int32)
    
        a_tf = tf.range(2 * 20 * 7 * 7, dtype='float')
        a_tf = tf.reshape(a_tf, [2, 20, 7, 7])
        b_tf = tf.nn.depth_to_space(a_tf, block_size=2, data_format="NCHW")
        c_tf = tf.nn.space_to_depth(b_tf, block_size=2, data_format="NCHW")
        b_tf = b_tf.numpy().astype(np.int32)
        c_tf = c_tf.numpy().astype(np.int32)
    
        print(np.all(b == b_tf))
        print(np.all(c == c_tf))
        print()

[Real-Time Single Image and Video Super-Resolution Using an Efficient Sub-Pixel Convolutional Neural Network]: https://arxiv.org/abs/1609.05158
[1]: /images/20221024/10090b7f25694b6592af1b2c049573f2.png
[Is the deconvolution layer the same as a convolutional layer]: https://arxiv.org/abs/1609.07009
[Deconvolution and Checkerboard Artifacts]: https://distill.pub/2016/deconv-checkerboard/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JieTE5ODc_size_16_color_FFFFFF_t_70_pic_center]: /images/20221024/65fb294fe9314a6da87b963a051e9b9c.png
[20210130231332227.png_pic_center]: /images/20221024/f34b6061f0d240a591ba977084c6e5d5.png
[Pytorch]: https://blog.csdn.net/bby1987/article/details/109590108
[numpy_reshape_transpose]: https://blog.csdn.net/bby1987/article/details/113729250
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JieTE5ODc_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221024/cf90f2afc5874907b1dcf7eb3475d736.png