afm_scan: Constructs an "afm_scan" S3 object from inputs

In will-r-chase/afmr: Visualization and Analysis of AFM Images

Description

Constructs an "afm_scan" S3 object from inputs

Usage

afm_scan(scan_points = NULL, scanSize = NULL, sampsPerLine = NULL,
  afmLines = NULL, maps = list(), optional_params = list())

Arguments

scan_points	(required) A tibble with the scan data
scanSize	(required) The scan size
sampsPerLine	(required) The samples per line
afmLines	(required) The number of lines
maps	(optional) afm maps (matrices)
optional_params	(optional) Any other parameters to include (see details)

Details

This function is typically used under the hood by afm_read_bruker, but it can be used to construct an afm_scan object from a list of values which could be useful as a control or for teaching. The first four parameters are required, while the maps and optional_params are optional. Supplied maps should be a list of matrices representing the matrix representation of different afm channels. Other parameters such as experimental details should be supplied as a list to optional_params.

Value

An S3 object of class "afm_scan"

will-r-chase/afmr documentation built on May 9, 2019, 4:11 p.m.