---
title: "ClikaRT::nn::PixelUnshuffleOptions"
sidebar_label: "PixelUnshuffleOptions"
description: "Settings of PixelUnshuffle: chain the setters, or assign the fields."
---

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

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

**Header:** `ClikaRT/nn/generated/pixelshuffle.h`

Settings of [`PixelUnshuffle`](./PixelUnshuffle.md): chain the setters, or assign the fields.

## Member functions

### PixelUnshuffleOptions() {#PixelUnshuffleOptions}

<div class="api-signature">

**`PixelUnshuffleOptions`**(`std::int64_t` `downscale_factor`)

</div>

`PixelUnshuffleOptions(downscale_factor)`: implicit, so `PixelUnshuffle(downscale_factor)` reads like the function call.

<div class="api-declared">

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

</div>

### downscale\_factor(int64\_t) {#downscale_factor}

<div class="api-signature">

[`PixelUnshuffleOptions`](./PixelUnshuffleOptions.md)`&` **`downscale_factor`**(`std::int64_t` `v`)

</div>

Sets [`downscale_factor`](./PixelUnshuffleOptions.md#downscale_factor), the factor `r`.

<div class="api-declared">

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

</div>

### downscale\_factor() {#downscale_factor-2}

<div class="api-signature">

`std::int64_t` **`downscale_factor`**() `const`

</div>

Reads [`downscale_factor`](./PixelUnshuffleOptions.md#downscale_factor).

<div class="api-declared">

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

</div>

### mode(ops::PixelShuffleMode) {#mode}

<div class="api-signature">

[`PixelUnshuffleOptions`](./PixelUnshuffleOptions.md)`&` **`mode`**([`ops::PixelShuffleMode`](../ops/index.md#PixelShuffleMode) `v`)

</div>

Sets [`mode`](./PixelUnshuffleOptions.md#mode), the channel ordering of the packed output.

<div class="api-declared">

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

</div>

### mode() {#mode-2}

<div class="api-signature">

[`ops::PixelShuffleMode`](../ops/index.md#PixelShuffleMode) **`mode`**() `const`

</div>

Reads [`mode`](./PixelUnshuffleOptions.md#mode).

<div class="api-declared">

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

</div>

## Data members

### downscale\_factor\_ {#downscale_factor_}

<div class="api-signature">

`std::int64_t` **`downscale_factor_`**

</div>

The factor `r`. Required: set through the constructor.

<div class="api-declared">

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

</div>

### mode\_ {#mode_}

<div class="api-signature">

[`ops::PixelShuffleMode`](../ops/index.md#PixelShuffleMode) **`mode_`** `=` [`ops::PixelShuffleMode::CRD`](../ops/index.md#PixelShuffleMode)

</div>

The channel ordering of the packed output. Default [`ops::PixelShuffleMode::CRD`](../ops/index.md#PixelShuffleMode).

<div class="api-declared">

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

</div>