---
title: "ClikaRT::nn::FoldOptions"
sidebar_label: "FoldOptions"
description: "Settings of Fold: 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 [`Fold`](./Fold.md): chain the setters, or assign the fields.

## Member functions

### FoldOptions() {#FoldOptions}

<div class="api-signature">

`explicit` **`FoldOptions`**(`std::vector<std::int64_t>` `output_size`, `std::vector<std::int64_t>` `kernel_size`)

</div>

`FoldOptions(output_size, kernel_size)`: the positional form.

<div class="api-declared">

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

</div>

### output\_size(vector\<int64\_t\>) {#output_size}

<div class="api-signature">

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

</div>

Sets [`output_size`](./FoldOptions.md#output_size), the spatial extents of the reconstructed image.

<div class="api-declared">

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

</div>

### output\_size() {#output_size-2}

<div class="api-signature">

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

</div>

Reads [`output_size`](./FoldOptions.md#output_size).

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

1. ​

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

Sets [`padding`](./FoldOptions.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 76

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

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

</div>

## Data members

### output\_size\_ {#output_size_}

<div class="api-signature">

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

</div>

The spatial extents of the reconstructed image. Required: set through the constructor.

<div class="api-declared">

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

</div>

### 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 61

</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 72

</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 84

</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 91

</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 98

</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 105

</div>