---
title: "ClikaRT::nn::PixelUnshuffle"
sidebar_label: "PixelUnshuffle"
description: "Moves spatial samples into the channels: [N, H * r, W * r, C] to [N, H, W, C * r * r] for the factor r."
---

<!-- Generated by tools/doxygen2mdx from Doxygen XML. Do not edit. -->

<span class="api-kind api-kind--class">class</span>

**Header:** `ClikaRT/nn/generated/pixelshuffle.h`  
**Inherits:** [`ClikaRT::nn::Module`](./Module.md)

Moves spatial samples into the channels: `[N, H * r, W * r, C]` to `[N, H, W, C * r * r]` for the factor `r`. The module form of [`ClikaRT::ops::pixel_unshuffle`](../ops/pixel_unshuffle.md#pixel_unshuffle), which documents the full contract (shapes, dtypes, errors); construct once, then call it like a function.

## Member functions

### PixelUnshuffle(PixelUnshuffleOptions) {#PixelUnshuffle}

<div class="api-signature">

`explicit` **`PixelUnshuffle`**([`PixelUnshuffleOptions`](./PixelUnshuffleOptions.md) `options`)

</div>

Constructs the module from [`options`](./PixelUnshuffle.md#options).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pixelshuffle.h`, line 130

</div>

### PixelUnshuffle(int64\_t) {#PixelUnshuffle-2}

<div class="api-signature">

`explicit` **`PixelUnshuffle`**(`std::int64_t` `downscale_factor`)

</div>

`PixelUnshuffle(downscale_factor)`: the positional form of `PixelUnshuffleOptions(downscale_factor)`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pixelshuffle.h`, line 133

</div>

### forward() {#forward}

<div class="api-signature">

[`Tensor`](../Tensor.md) **`forward`**([`Tensor`](../Tensor.md) `input`) `const`

</div>

[`forward_impl`](./PixelUnshuffle.md#forward), unwrapped: raises [`ClikaRT::Error`](../Error.md) on failure.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pixelshuffle.h`, line 146

</div>

### operator()() {#operator-call}

<div class="api-signature">

[`Tensor`](../Tensor.md) **`operator()`**([`Tensor`](../Tensor.md) `input`) `const`

</div>

Same as [`forward`](./PixelUnshuffle.md#forward).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pixelshuffle.h`, line 150

</div>

### options() {#options}

<div class="api-signature">

`const` [`PixelUnshuffleOptions`](./PixelUnshuffleOptions.md)`&` **`options`**() `const`

</div>

The settings this module was constructed with.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/pixelshuffle.h`, line 154

</div>