---
title: "ClikaRT::nn::UpsampleOptions"
sidebar_label: "UpsampleOptions"
description: "Settings of Upsample: 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/upsampling.h`

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

## Member functions

### size(vector\<ScalarOrTensor\>) {#size}

<div class="api-signature">

[`UpsampleOptions`](./UpsampleOptions.md)`&` **`size`**(`std::vector<`[`ScalarOrTensor`](../ScalarOrTensor.md)`>` `v`)

</div>

Sets [`size`](./UpsampleOptions.md#size), the target spatial extents; each entry an integer or a 0-D tensor.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/upsampling.h`, line 38

</div>

### size() {#size-2}

<div class="api-signature">

`const std::vector<`[`ScalarOrTensor`](../ScalarOrTensor.md)`>&` **`size`**() `const`

</div>

Reads [`size`](./UpsampleOptions.md#size).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/upsampling.h`, line 43

</div>

### scale\_factor(vector\<ScalarOrTensor\>) {#scale_factor}

<div class="api-signature">

[`UpsampleOptions`](./UpsampleOptions.md)`&` **`scale_factor`**(`std::vector<`[`ScalarOrTensor`](../ScalarOrTensor.md)`>` `v`)

</div>

Sets [`scale_factor`](./UpsampleOptions.md#scale_factor), the multiplier per spatial dimension; each entry a number or a 0-D tensor.

<div class="api-declared">

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

</div>

### scale\_factor() {#scale_factor-2}

<div class="api-signature">

`const std::vector<`[`ScalarOrTensor`](../ScalarOrTensor.md)`>&` **`scale_factor`**() `const`

</div>

Reads [`scale_factor`](./UpsampleOptions.md#scale_factor).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/upsampling.h`, line 55

</div>

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

<div class="api-signature">

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

</div>

Sets [`mode`](./UpsampleOptions.md#mode), the interpolation mode.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/upsampling.h`, line 61

</div>

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

<div class="api-signature">

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

</div>

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

<div class="api-declared">

Declared in `ClikaRT/nn/generated/upsampling.h`, line 63

</div>

### align\_corners(optional\<bool\>) {#align_corners}

<div class="api-signature">

[`UpsampleOptions`](./UpsampleOptions.md)`&` **`align_corners`**(`std::optional<bool>` `v`)

</div>

Sets [`align_corners`](./UpsampleOptions.md#align_corners), aligns the corner samples of input and output for the linear modes.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/upsampling.h`, line 69

</div>

### align\_corners() {#align_corners-2}

<div class="api-signature">

`const std::optional<bool>&` **`align_corners`**() `const`

</div>

Reads [`align_corners`](./UpsampleOptions.md#align_corners).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/upsampling.h`, line 74

</div>

### recompute\_scale\_factor(bool) {#recompute_scale_factor}

<div class="api-signature">

[`UpsampleOptions`](./UpsampleOptions.md)`&` **`recompute_scale_factor`**(`bool` `v`)

</div>

Sets [`recompute_scale_factor`](./UpsampleOptions.md#recompute_scale_factor), derives the effective scale from the computed output size.

<div class="api-declared">

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

</div>

### recompute\_scale\_factor() {#recompute_scale_factor-2}

<div class="api-signature">

`bool` **`recompute_scale_factor`**() `const`

</div>

Reads [`recompute_scale_factor`](./UpsampleOptions.md#recompute_scale_factor).

<div class="api-declared">

Declared in `ClikaRT/nn/generated/upsampling.h`, line 86

</div>

### antialias(bool) {#antialias}

<div class="api-signature">

[`UpsampleOptions`](./UpsampleOptions.md)`&` **`antialias`**(`bool` `v`)

</div>

Sets [`antialias`](./UpsampleOptions.md#antialias), low-pass filters when downsampling.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/upsampling.h`, line 92

</div>

### antialias() {#antialias-2}

<div class="api-signature">

`bool` **`antialias`**() `const`

</div>

Reads [`antialias`](./UpsampleOptions.md#antialias).

<div class="api-declared">

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

</div>

## Data members

### size\_ {#size_}

<div class="api-signature">

`std::vector<`[`ScalarOrTensor`](../ScalarOrTensor.md)`>` **`size_`** `= {}`

</div>

The target spatial extents; each entry an integer or a 0-D tensor. Default `{}`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/upsampling.h`, line 46

</div>

### scale\_factor\_ {#scale_factor_}

<div class="api-signature">

`std::vector<`[`ScalarOrTensor`](../ScalarOrTensor.md)`>` **`scale_factor_`** `= {}`

</div>

The multiplier per spatial dimension; each entry a number or a 0-D tensor. Default `{}`.

<div class="api-declared">

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

</div>

### mode\_ {#mode_}

<div class="api-signature">

[`ops::InterpMode`](../ops/index.md#InterpMode) **`mode_`** `=` [`ops::InterpMode::Nearest`](../ops/index.md#InterpMode)

</div>

The interpolation mode. Default [`ops::InterpMode::Nearest`](../ops/index.md#InterpMode).

<div class="api-declared">

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

</div>

### align\_corners\_ {#align_corners_}

<div class="api-signature">

`std::optional<bool>` **`align_corners_`** `= std::nullopt`

</div>

Aligns the corner samples of input and output for the linear modes. Default `std::nullopt`.

<div class="api-declared">

Declared in `ClikaRT/nn/generated/upsampling.h`, line 77

</div>

### recompute\_scale\_factor\_ {#recompute_scale_factor_}

<div class="api-signature">

`bool` **`recompute_scale_factor_`** `= false`

</div>

Derives the effective scale from the computed output size. Default `false`.

<div class="api-declared">

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

</div>

### antialias\_ {#antialias_}

<div class="api-signature">

`bool` **`antialias_`** `= false`

</div>

Low-pass filters when downsampling. Default `false`.

<div class="api-declared">

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

</div>