---
title: "ClikaRT::nn::UnfoldOptions"
sidebar_label: "UnfoldOptions"
description: "Settings of Unfold: 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/fold.h`

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

## Member functions

### UnfoldOptions() {#UnfoldOptions}

<div class="api-signature">

**`UnfoldOptions`**(`std::vector<std::int64_t>` `kernel_size`)

</div>

`UnfoldOptions(kernel_size)`: implicit, so `Unfold(kernel_size)` reads like the function call.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 155

</div>

### kernel\_size(vector\<int64\_t\>) {#kernel_size}

<div class="api-signature">

[`UnfoldOptions`](./UnfoldOptions.md)`&` **`kernel_size`**(`std::vector<std::int64_t>` `v`)

</div>

Sets [`kernel_size`](./UnfoldOptions.md#kernel_size), the window extent per spatial dimension.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 159

</div>

### kernel\_size() {#kernel_size-2}

<div class="api-signature">

`const std::vector<std::int64_t>&` **`kernel_size`**() `const`

</div>

Reads [`kernel_size`](./UnfoldOptions.md#kernel_size).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 164

</div>

### dilation(vector\<int64\_t\>) {#dilation}

<div class="api-signature">

[`UnfoldOptions`](./UnfoldOptions.md)`&` **`dilation`**(`std::vector<std::int64_t>` `v`)

</div>

Sets [`dilation`](./UnfoldOptions.md#dilation), the window dilation per spatial dimension; empty is

1. ​

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 171

</div>

### dilation() {#dilation-2}

<div class="api-signature">

`const std::vector<std::int64_t>&` **`dilation`**() `const`

</div>

Reads [`dilation`](./UnfoldOptions.md#dilation).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 176

</div>

### padding(vector\<int64\_t\>) {#padding}

<div class="api-signature">

[`UnfoldOptions`](./UnfoldOptions.md)`&` **`padding`**(`std::vector<std::int64_t>` `v`)

</div>

Sets [`padding`](./UnfoldOptions.md#padding), the `(low, high)` pad pairs per spatial axis; empty is no padding.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 182

</div>

### padding() {#padding-2}

<div class="api-signature">

`const std::vector<std::int64_t>&` **`padding`**() `const`

</div>

Reads [`padding`](./UnfoldOptions.md#padding).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 187

</div>

### stride(vector\<int64\_t\>) {#stride}

<div class="api-signature">

[`UnfoldOptions`](./UnfoldOptions.md)`&` **`stride`**(`std::vector<std::int64_t>` `v`)

</div>

Sets [`stride`](./UnfoldOptions.md#stride), the window step per spatial dimension; empty is 1.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 193

</div>

### stride() {#stride-2}

<div class="api-signature">

`const std::vector<std::int64_t>&` **`stride`**() `const`

</div>

Reads [`stride`](./UnfoldOptions.md#stride).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 198

</div>

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

<div class="api-signature">

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

</div>

Sets [`mode`](./UnfoldOptions.md#mode), how the padded region is filled.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 203

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 205

</div>

### value(optional\<double\>) {#value}

<div class="api-signature">

[`UnfoldOptions`](./UnfoldOptions.md)`&` **`value`**(`std::optional<double>` `v`)

</div>

Sets [`value`](./UnfoldOptions.md#value), the constant fill; unset is 0.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 210

</div>

### value() {#value-2}

<div class="api-signature">

`const std::optional<double>&` **`value`**() `const`

</div>

Reads [`value`](./UnfoldOptions.md#value).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 212

</div>

## Data members

### kernel\_size\_ {#kernel_size_}

<div class="api-signature">

`std::vector<std::int64_t>` **`kernel_size_`**

</div>

The window extent per spatial dimension. Required: set through the constructor.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 167

</div>

### dilation\_ {#dilation_}

<div class="api-signature">

`std::vector<std::int64_t>` **`dilation_`** `= {}`

</div>

The window dilation per spatial dimension; empty is 1. Default `{}`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 178

</div>

### padding\_ {#padding_}

<div class="api-signature">

`std::vector<std::int64_t>` **`padding_`** `= {}`

</div>

The `(low, high)` pad pairs per spatial axis; empty is no padding. Default `{}`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 190

</div>

### stride\_ {#stride_}

<div class="api-signature">

`std::vector<std::int64_t>` **`stride_`** `= {}`

</div>

The window step per spatial dimension; empty is 1. Default `{}`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 200

</div>

### mode\_ {#mode_}

<div class="api-signature">

[`ops::PadMode`](../ops/index.md#PadMode) **`mode_`** `=` [`ops::PadMode::Constant`](../ops/index.md#PadMode)

</div>

How the padded region is filled. Default [`ops::PadMode::Constant`](../ops/index.md#PadMode).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 207

</div>

### value\_ {#value_}

<div class="api-signature">

`std::optional<double>` **`value_`** `= std::nullopt`

</div>

The constant fill; unset is 0. Default `std::nullopt`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/fold.h`, line 214

</div>