im2col.h 3.5 KB
Newer Older
H
hedaoyuan 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserve.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. */

#pragma once

H
hedaoyuan 已提交
17 18
#include "paddle/framework/tensor.h"
#include "paddle/platform/device_context.h"
H
hedaoyuan 已提交
19 20

namespace paddle {
21
namespace operators {
22
namespace math {
H
hedaoyuan 已提交
23 24

/* The storage format of the coldata in the Im2ColFunctor and Col2ImFunctor. */
H
hedaoyuan 已提交
25
enum class ColFormat { kCFO = 0, kOCF = 1 };
H
hedaoyuan 已提交
26 27 28 29 30 31 32 33

/*
 * \brief Converts the image data of three dimensions(CHW) into a colData of
 *        five dimensions in the Im2ColFunctor calculation,
 *        And in the Col2ImFunctor calculation, it is reversed.
 *
 * \param imData   Image data.
 * \param imShape  The shape of imData,
H
hedaoyuan 已提交
34
 *                 [input_channels, input_height, input_width].
H
hedaoyuan 已提交
35 36 37 38
 * \param colData  Column data.
 * \param colShape The shape of colData.
 *
 * If the template argument Format is kCFO, the shape of colData is:
H
hedaoyuan 已提交
39
 * [input_channels, filter_height, filter_width, output_height, output_width]
H
hedaoyuan 已提交
40 41 42
 * So, it is easy to reshape into a convolution matrix for convolution
 * calculation based on matrix multiplication.
 * The shape of convolution matrix is [height, width], where the height is equal
H
hedaoyuan 已提交
43 44
 * input_channels * filter_height * filter_width, and the width is equal
 * output_height * output_width.
H
hedaoyuan 已提交
45 46 47
 *
 * Reshape:
 *     shape of colData           shape of convolution matrix
H
hedaoyuan 已提交
48 49 50 51 52
 *     [input_channels,
 *      filter_height,
 *      filter_width,      ======>      [height, width]
 *      output_height,
 *      output_width]
H
hedaoyuan 已提交
53 54
 *
 * If the template argument Format is kOCF, the shape of colData is:
H
hedaoyuan 已提交
55
 * [output_height, output_width, input_channels, filter_height, filter_width]
H
hedaoyuan 已提交
56
 * So, it is easy to reshape into a sequence matrix for rnn calculation.
H
hedaoyuan 已提交
57 58 59
 * The shape of sequence matrix is [seq_length, step_size], where the seq_length
 * is equal output_height * output_width, and the step_size is equal
 * input_channels * filter_height * filter_width.
H
hedaoyuan 已提交
60 61 62
 *
 * Reshape:
 *     shape of colData             shape of sequence matrix
H
hedaoyuan 已提交
63 64 65 66 67
 *     [output_height,
 *      output_width,
 *      input_channels,    ======>    [seqLength, stepSize]
 *      filter_height,
 *      filter_width]
H
hedaoyuan 已提交
68 69 70 71
 *
 * \note The caller needs to ensure that imShape.inputChannels is equal to
 *       colShape.inputChannels.
 */
H
hedaoyuan 已提交
72
template <ColFormat Format, typename Place, typename T>
H
hedaoyuan 已提交
73 74
class Im2ColFunctor {
 public:
H
hedaoyuan 已提交
75 76
  void operator()(const platform::DeviceContext& context,
                  const framework::Tensor& im, framework::Tensor& col,
C
chengduoZH 已提交
77 78
                  int stride_height, int stride_width, int padding_up,
                  int padding_down, int padding_left, int padding_right);
H
hedaoyuan 已提交
79 80
};

H
hedaoyuan 已提交
81
template <ColFormat Format, typename Place, typename T>
H
hedaoyuan 已提交
82 83
class Col2ImFunctor {
 public:
H
hedaoyuan 已提交
84 85
  void operator()(const platform::DeviceContext& context, framework::Tensor& im,
                  const framework::Tensor& col, int stride_height,
C
chengduoZH 已提交
86 87
                  int stride_width, int padding_up, int padding_down,
                  int padding_left, int padding_right);
H
hedaoyuan 已提交
88 89
};

90
}  // namespace math
91
}  // namespace operators
H
hedaoyuan 已提交
92
}  // namespace paddle