oXim (version 1.2.2)

createFilterSetting: Create filter-settings Object.

Description

This function allows to create correctly a filter-settings object in order to insert as input on getOxyrange function.

Usage

createFilterSetting(name = "default", type = NULL, radius = NULL,
  times = NULL, tolerance = NULL)

Arguments

name

Parameter to indicate prefixed profile of settings. This parameter has priority over the others.

type

Indicates type of filter to use. See details below.

radius

Indicates the size (on pixels) of sides of square used to apply the filters.

times

Indicates number of times to apply the filters.

tolerance

For noiselessFilter, this parameter indicates proportion of pixels to consider from filter matrix (radius x radius).

Details

About each parameter:

name

This parameter must be a string and it works as a short way to select an specific set of filter settings. This parameter has priority over the others, so to create a personalized set of filters, `name` will must set as NULL. (It will be fully available in next version.)

type

This parameter must be a string and indicates what kind of filter method will be applied to the echograms. There are two options to select: definerFilter which works as a reverse-effect median filter and noiselessFilter which removes noisy signals on the echograms.

radius

This parameter is useful to specify the size of the filter matrix which will be applied to the echogram. It must be integer, even and greater than 3.

times

This parameter is useful to indicate how many times the filter will be applied to the echogram. It must be integer and greater than 1. The function will remove rows with times=0 values.

tolerance

Internal parameter to modify selected values on a convolution matrix filter. This parameter is meaningful only for noiselessFilter.

Examples

# NOT RUN {
# Use default profile
createFilterSetting(name = "default")

# Generate a personalized profile
createFilterSetting(type = "definerFilter", radius = c(3, 5, 5))
# }