Oakfield API Documentation 1.0.0
Numerical core APIs
Loading...
Searching...
No Matches
SimMaskOperatorConfig Struct Reference

Configuration for the mask/apply operator. More...

#include <mask_apply.h>

Public Attributes

size_t input_field
 
size_t mask_field
 
size_t output_field
 
SimMaskMode mode
 
double threshold
 
double feather
 
double fill_value
 
double fill_value_im
 
bool accumulate
 
bool scale_by_dt
 

Detailed Description

Configuration for the mask/apply operator.

Member Data Documentation

◆ accumulate

bool SimMaskOperatorConfig::accumulate

Add into output when true.

◆ feather

double SimMaskOperatorConfig::feather

Soft transition half-width (0 for hard mask).

◆ fill_value

double SimMaskOperatorConfig::fill_value

Fill value used when mask is inactive.

◆ fill_value_im

double SimMaskOperatorConfig::fill_value_im

Imaginary fill value when output is complex.

◆ input_field

size_t SimMaskOperatorConfig::input_field

Field supplying values to be masked.

◆ mask_field

size_t SimMaskOperatorConfig::mask_field

Field supplying mask values.

◆ mode

SimMaskMode SimMaskOperatorConfig::mode

Apply vs invert mask.

◆ output_field

size_t SimMaskOperatorConfig::output_field

Field receiving the masked result.

◆ scale_by_dt

bool SimMaskOperatorConfig::scale_by_dt

Scale accumulated writes by substep dt.

◆ threshold

double SimMaskOperatorConfig::threshold

Threshold for binary masking.


The documentation for this struct was generated from the following file: