Skip to main content

ClikaRT::nn::FoldOptions

struct

Header: ClikaRT/nn/generated/fold.h

Settings of Fold: chain the setters, or assign the fields.

Member functions​

FoldOptions()​

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

FoldOptions(output_size, kernel_size): the positional form.

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

output_size(vector<int64_t>)​

FoldOptions& output_size(std::vector<std::int64_t> v)

Sets output_size, the spatial extents of the reconstructed image.

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

output_size()​

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

Reads output_size.

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

kernel_size(vector<int64_t>)​

FoldOptions& kernel_size(std::vector<std::int64_t> v)

Sets kernel_size, the window extent per spatial dimension.

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

kernel_size()​

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

Reads kernel_size.

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

dilation(vector<int64_t>)​

FoldOptions& dilation(std::vector<std::int64_t> v)

Sets dilation, the window dilation per spatial dimension; empty is

  1. ​

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

dilation()​

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

Reads dilation.

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

padding(vector<int64_t>)​

FoldOptions& padding(std::vector<std::int64_t> v)

Sets padding, the (low, high) pad pairs per spatial axis; empty is no padding.

Declared in ClikaRT/nn/generated/fold.h, line 76

padding()​

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

Reads padding.

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

stride(vector<int64_t>)​

FoldOptions& stride(std::vector<std::int64_t> v)

Sets stride, the window step per spatial dimension; empty is 1.

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

stride()​

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

Reads stride.

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

mode(ops::PadMode)​

FoldOptions& mode(ops::PadMode v)

Sets mode, how the padded region is filled.

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

mode()​

ops::PadMode mode() const

Reads mode.

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

value(optional<double>)​

FoldOptions& value(std::optional<double> v)

Sets value, the constant fill; unset is 0.

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

value()​

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

Reads value.

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

Data members​

output_size_​

std::vector<std::int64_t> output_size_

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

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

kernel_size_​

std::vector<std::int64_t> kernel_size_

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

Declared in ClikaRT/nn/generated/fold.h, line 61

dilation_​

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

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

Declared in ClikaRT/nn/generated/fold.h, line 72

padding_​

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

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

Declared in ClikaRT/nn/generated/fold.h, line 84

stride_​

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

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

Declared in ClikaRT/nn/generated/fold.h, line 91

mode_​

ops::PadMode mode_ = ops::PadMode::Constant

How the padded region is filled. Default ops::PadMode::Constant.

Declared in ClikaRT/nn/generated/fold.h, line 98

value_​

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

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

Declared in ClikaRT/nn/generated/fold.h, line 105