makeMedium: Generating medium impulse response.

Description Usage Arguments Value

View source: R/makeMedium.R

Description

A function that generates medium impulse response.

Usage

1
2
3
4
5
6
makeMedium(plate = makePlate(), plateTheory = c("lamb", "mindlin",
  "kirchhoff"), excitabilityData = "titaniumEF", modes = NULL,
  sensorDiameter = 0, sensorPosition = c(0.254, 0.19),
  sourcePosition = c(0.204, 0.19), sourceType = c("impulse", "step"),
  duration = 0.0001024, xunit = c("time", "samples"),
  samp.rate = 1e+07, bit = 32)

Arguments

plate

Plate specification, Default: makePlate()

plateTheory

Plate theory model, Default: c("lamb", "mindlin", "kirchhoff")

excitabilityData

Excitability function data, Default: 'titaniumEF'

modes

Maximum number of modes c(m,n), Default: NULL

sensorDiameter

Sensor diameter (in m), Default: 0

sensorPosition

Sensor position coordinates c(x,y) in m, Default: c(0.254, 0.19)

sourcePosition

Sensor position coordinates c(x0,y0) in m, Default: c(0.204, 0.19)

sourceType

Source type, Default: c("impulse", "step")

duration

Duration of the Wave in xunit, Default: 0.0001024

xunit

Character indicating which unit is used in argument duration. If xunit = "time", the unit is time in s, otherwise the number of samples, Default: c("time", "samples")

samp.rate

Sampling rate of the Wave, in Hz, Default: 1e+07

bit

Resolution of the Wave and rescaling unit, Default: 32. This may be 1 for rescaling to numeric values in [-1,1], 8 (i.e. 8-bit) for rescaling to integers in [0, 254], 16 (i.e. 16-bit) for rescaling to integers in [-32767, 32767], 24 (i.e. 24-bit) for rescaling to integers in [-8388607, 8388607], 32 (i.e. 32-bit) for rescaling either to integers in [-2147483647, 2147483647], 64 (i.e. 64-bit) for rescaling to numeric values in [-1, 1] (FLOAT_IEEE Wave format), and 0 for not rescaling at all.

Value

The medium impulse response waveform as a medium object.


gmxavier/pongaR documentation built on Sept. 7, 2021, 1:06 p.m.