batchToSpace(_:spatialAxesTensor:batchAxisTensor:blockDimensionsTensor:usePixelShuffleOrder:name:)
Creates a batch-to-space operation and returns the result tensor.
Declaration
func batchToSpace(_ tensor: MPSGraphTensor, spatialAxesTensor: MPSGraphTensor, batchAxisTensor: MPSGraphTensor, blockDimensionsTensor: MPSGraphTensor, usePixelShuffleOrder: Bool, name: String?) -> MPSGraphTensorParameters
- tensor:
The input tensor.
- spatialAxesTensor:
A tensor that contains the axes that define the dimensions containing the spatial blocks.
- batchAxisTensor:
A tensor that contains the axis that defines the destination dimension, where to copy the blocks.
- blockDimensionsTensor:
A tensor that defines the size of the rectangular spatial sub-block.
- usePixelShuffleOrder:
A parameter that controls layout of the sub-blocks within the batch dimension.
- name:
The name for the operation.
Return Value
A valid MPSGraphTensor object.
Discussion
This operation outputs a copy of the input tensor, where values from the batchAxisTensor dimension are moved in spatial blocks of size blockDimensionsTensor to the spatialAxesTensor dimensions (for usePixelShuffleOrder=YES 1,2 or 3 axes supported, otherwise limited only by MPSNDArray rank limitations). Use the usePixelShuffleOrder parameter to control how the data within spatial blocks is ordered in the batchAxisTensor dimension: with usePixelShuffleOrder = YES MPSGraph stores the values of the spatial block contiguosly within the batchAxisTensor dimension whereas without it they are stored interleaved with existing values in the batchAxisTensor dimension. Note: This operation is the inverse of spaceToBatch(_:spatialAxesTensor:batchAxisTensor:blockDimensionsTensor:usePixelShuffleOrder:name:). Note: This operation is a generalization of depth(toSpace2DTensor:widthAxisTensor:heightAxisTensor:depthAxisTensor:blockSize:usePixelShuffleOrder:name:).