conv2.cc File Reference

#include "oct-convn.h"
#include "defun-dld.h"
#include "error.h"
#include "oct-obj.h"
#include "utils.h"

Include dependency graph for conv2.cc:

Go to the source code of this file.

Enumerations
enum	Shape { SHAPE_FULL, SHAPE_SAME, SHAPE_VALID }
Functions
	DEFUN_DLD (conv2, args,,"-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} conv2 (@var{A}, @var{B})\n\ @deftypefnx {Loadable Function} {} conv2 (@var{v1}, @var{v2}, @var{m})\n\ @deftypefnx {Loadable Function} {} conv2 (@dots{}, @var{shape})\n\ Return the 2-D convolution of @var{A} and @var{B}. The size of the result\n\ is determined by the optional @var{shape} argument which takes the following\n\ values\n\ \n\ @table @asis\n\ @item @var{shape} = \"full\"\n\ Return the full convolution. (default)\n\ \n\ @item @var{shape} = \"same\"\n\ Return the central part of the convolution with the same size as @var{A}.\n\ The central part of the convolution begins at the indices\n\ @code{floor ([size(@var{B})/2] + 1)}.\n\ \n\ @item @var{shape} = \"valid\"\n\ Return only the parts which do not include zero-padded edges.\n\ The size of the result is @code{max (size (A) - size (B) + 1, 0)}.\n\ @end table\n\ \n\ When the third argument is a matrix, return the convolution of the matrix\n\ @var{m} by the vector @var{v1} in the column direction and by the vector\n\ @var{v2} in the row direction.\n\ @seealso{conv, convn}\n\ @end deftypefn")
	DEFUN_DLD (convn, args,,"-*- texinfo -*-\n\ @deftypefn {Loadable Function} {@var{C} =} convn (@var{A}, @var{B})\n\ @deftypefnx {Loadable Function} {@var{C} =} convn (@var{A}, @var{B}, @var{shape})\n\ Return the n-D convolution of @var{A} and @var{B}. The size of the result\n\ is determined by the optional @var{shape} argument which takes the following\n\ values\n\ \n\ @table @asis\n\ @item @var{shape} = \"full\"\n\ Return the full convolution. (default)\n\ \n\ @item @var{shape} = \"same\"\n\ Return central part of the convolution with the same size as @var{A}.\n\ The central part of the convolution begins at the indices\n\ @code{floor ([size(@var{B})/2] + 1)}.\n\ \n\ @item @var{shape} = \"valid\"\n\ Return only the parts which do not include zero-padded edges.\n\ The size of the result is @code{max (size (A) - size (B) + 1, 0)}.\n\ @end table\n\ \n\ @seealso{conv2, conv}\n\ @end deftypefn")

---

Enumeration Type Documentation

enum Shape

Enumerator:

SHAPE_FULL
SHAPE_SAME
SHAPE_VALID

Definition at line 35 of file conv2.cc.

---

Function Documentation

DEFUN_DLD	(	conv2	,
		args
	)

Definition at line 37 of file conv2.cc.

References error(), print_usage(), and octave_value::string_value().

DEFUN_DLD	(	convn	,
		args
	)

Definition at line 287 of file conv2.cc.

References error(), print_usage(), and octave_value::string_value().