write.ssif: Calculates and (optionally) writes to file the spherical...

View source: R/write.ssif.R

write.ssifR Documentation

Calculates and (optionally) writes to file the spherical surface integral of a beam pattern from acoustic fish models at radius 1 meter, for the grid of the product 'kL' of wavenumber and size of the acoustic model.

Description

Calculates and (optionally) writes to file the spherical surface integral of a beam pattern from acoustic fish models at radius 1 meter, for the grid of the product 'kL' of wavenumber and size of the acoustic model.

Usage

write.ssif(
  x = NULL,
  outfile = NULL,
  pres = 1e-06,
  max.cells = 1e+06,
  onlyssif.out = TRUE
)

Arguments

x

is either a list of the data ('grsf' (grid of the product of wavenumber and size of the acoustic model) and 'ebpf' (empirical beam pattern table) and at least one of 'graf' (grid azimuth angle) and 'gref' (grid elevation angle)) or a path to the TSD file holding the empirical beam pattern.

outfile

is the path to the file to which the data should be written, FALSE if no data should be written to file, or if length(outfile) == 0 the default file name which is the input file added "_ssif" to the name is used (only applied in the case that 'x' is a TSD-file).

pres

is the desired presition of the integration (used in integrateonsphere()).

max.cells

is the maximum number of cells in the grid (used in integrateonsphere()).

onlyssif.out

is TRUE if the output should be only 'ssif', not the entire list read, added 'ssif'.


arnejohannesholmin/echoIBM documentation built on April 14, 2024, 11:37 p.m.