# BatchToSpace

public final class **BatchToSpace** BatchToSpace for 4-D tensors of type T.


This is a legacy version of the more general BatchToSpaceND.


Rearranges (permutes) data from batch into blocks of spatial data, followed by
cropping. This is the reverse transformation of SpaceToBatch. More specifically,
this op outputs a copy of the input tensor where values from the \`batch\`
dimension are moved in spatial blocks to the \`height\` and \`width\` dimensions,
followed by cropping along the \`height\` and \`width\` dimensions.

<br />

<br />

### Public Methods

|---|---|
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [asOutput](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/BatchToSpace#asOutput())() Returns the symbolic handle of a tensor. |
| static \<T, U extends Number\> [BatchToSpace](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/BatchToSpace)\<T\> | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/BatchToSpace#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand<T>,%20org.tensorflow.Operand<U>,%20java.lang.Long))([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> input, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<U\> crops, Long blockSize) Factory method to create a class wrapping a new BatchToSpace operation. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [output](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/BatchToSpace#output())() 4-D with shape \`\[batch, height, width, depth\]\`, where: height = height_pad - crop_top - crop_bottom width = width_pad - crop_left - crop_right The attr \`block_size\` must be greater than one. <br /> |

### Inherited Methods

From class [org.tensorflow.op.PrimitiveOp](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp)

|---|---|
| final boolean | [equals](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#equals(java.lang.Object))(Object obj) |
| final int | [hashCode](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#hashCode())() |
| [Operation](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation) | [op](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#op())() Returns the underlying `https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation` |
| final String | [toString](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#toString())() |

From class java.lang.Object

|---|---|
| boolean | equals(Object arg0) |
| final Class\<?\> | getClass() |
| int | hashCode() |
| final void | notify() |
| final void | notifyAll() |
| String | toString() |
| final void | wait(long arg0, int arg1) |
| final void | wait(long arg0) |
| final void | wait() |

From interface [org.tensorflow.Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)

|---|---|
| abstract [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\> | [asOutput](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand#asOutput())() Returns the symbolic handle of a tensor. |

## Public Methods

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\>
**asOutput**
()

Returns the symbolic handle of a tensor.

Inputs to TensorFlow operations are outputs of another TensorFlow operation. This method is
used to obtain a symbolic handle that represents the computation of the input.

<br />

#### public static [BatchToSpace](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/BatchToSpace)\<T\>
**create**
([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<T\> input, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<U\> crops, Long blockSize)

Factory method to create a class wrapping a new BatchToSpace operation.

##### Parameters

| scope | current scope |
| input | 4-D tensor with shape \`\[batch*block_size*block_size, height_pad/block_size, width_pad/block_size, depth\]\`. Note that the batch size of the input tensor must be divisible by \`block_size \* block_size\`. |
| crops | 2-D tensor of non-negative integers with shape \`\[2, 2\]\`. It specifies how many elements to crop from the intermediate result across the spatial dimensions as follows: crops = \[\[crop_top, crop_bottom\], \[crop_left, crop_right\]\] |
|---|---|

##### Returns

- a new instance of BatchToSpace

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<T\>
**output**
()

4-D with shape \`\[batch, height, width, depth\]\`, where:


height = height_pad - crop_top - crop_bottom
width = width_pad - crop_left - crop_right


The attr \`block_size\` must be greater than one. It indicates the block size.


Some examples:


(1) For the following input of shape \`\[4, 1, 1, 1\]\` and block_size of 2:

    [[[[1]]], [[[2]]], [[[3]]], [[[4]]]]
     
The output tensor has shape \`\[1, 2, 2, 1\]\` and value:

    x = [[[[1], [2]], [[3], [4]]]]
     
(2) For the following input of shape \`\[4, 1, 1, 3\]\` and block_size of 2:

    [[[[1, 2, 3]]], [[[4, 5, 6]]], [[[7, 8, 9]]], [[[10, 11, 12]]]]
     
The output tensor has shape \`\[1, 2, 2, 3\]\` and value:

    x = [[[[1, 2, 3], [4, 5, 6]],
           [[7, 8, 9], [10, 11, 12]]]]
     
(3) For the following input of shape \`\[4, 2, 2, 1\]\` and block_size of 2:

    x = [[[[1], [3]], [[9], [11]]],
          [[[2], [4]], [[10], [12]]],
          [[[5], [7]], [[13], [15]]],
          [[[6], [8]], [[14], [16]]]]
     
The output tensor has shape \`\[1, 4, 4, 1\]\` and value:

    x = [[[[1],   [2],  [3],  [4]],
          [[5],   [6],  [7],  [8]],
          [[9],  [10], [11],  [12]],
          [[13], [14], [15],  [16]]]]
     
(4) For the following input of shape \`\[8, 1, 2, 1\]\` and block_size of 2:

    x = [[[[1], [3]]], [[[9], [11]]], [[[2], [4]]], [[[10], [12]]],
          [[[5], [7]]], [[[13], [15]]], [[[6], [8]]], [[[14], [16]]]]
     
The output tensor has shape \`\[2, 2, 4, 1\]\` and value:

    x = [[[[1], [3]], [[5], [7]]],
          [[[2], [4]], [[10], [12]]],
          [[[5], [7]], [[13], [15]]],
          [[[6], [8]], [[14], [16]]]]
     
<br />

<br />

<br />

<br />

<br />