create_map: Create a mapping

View source: R/map_utilities.R

create_mapR Documentation

Create a mapping

Description

This function creates a mapping from a parameter list.

Usage

create_map(params)

Arguments

params

Parameter list with the mapping definition, see Details.

Details

It calls the mapping creation function responsible for mappings of maptype stated in the parameter list. It also invokes the setup function to initialize the mapping, provided by all mapping objects, see the Value section of create_maptype_map. For all maps the fields mapname and maptype must be present in the parameter list. The other parameters depend on the specifics of the mapping, see e.g., create_linearinterpol_map.

Value

Returns a list of functions to operate with the mapping, see create_maptype_map.

Note

This function should be preferred over the specialized mapping creation functions, such as create_linearinerpol_mapping.

See Also

Other mappings: create_compound_map(), create_convolution_with_xtrafo_map(), create_derivative2nd_map(), create_derivative_map(), create_linearinterpol_map(), create_linearinterpol_with_xtrafo_map(), create_linearmap_map(), create_maptype_map(), create_nonlinear_map(), create_normerr_map(), create_product_map()

Examples

params <- list(
  mapname = "mylinearintmap",
  maptype = "linearinterpol_map",
  src_idx = 1:3,
  tar_idx = 4:6,
  src_x = c(1,5,10),
  tar_x = c(4,5,6)
)
mymap <- create_map(params)
x <- c(1,2,3,0,0,0)
mymap$propagate(x)
mymap$jacobian(x)


gschnabel/nucdataBaynet documentation built on Feb. 3, 2023, 4:13 a.m.