rseg.event_oneping_write: Writes one ping of segmented data from the (SX90) unbiased...

In arnejohannesholmin/cpplot3d: 3D-plotting and segmentation of sonar data

Writes one ping of segmented data from the (SX90) unbiased segmentatino method. Used in rseg.event().

Description

Writes one ping of segmented data from the (SX90) unbiased segmentatino method. Used in rseg.event().

Usage

rseg.event_oneping_write(
  d,
  thisseg,
  thist,
  t,
  utim,
  valid,
  subset,
  dimvbsc,
  segfilesdir,
  sfnr,
  dBan,
  dBb1,
  dBb2,
  dBb3,
  dBb4,
  dBbs,
  Xsbg,
  Xsb1,
  thisthr,
  thersholdFromSchool,
  Xcsz,
  save.trh,
  save.data,
  save.ind,
  kern,
  wt,
  type,
  cmpred,
  ellipsoid,
  file_thist,
  reserve
)

Arguments

d	is the list of data including segmentation and acoustic data.
thisseg	is the segmentatino mask.
thist	is the time step index. One of 1:t.
t	is all the time steps to be segmented.
utim	is a a vector of UNIX time points corresponding to 't'.
valid	is indices of the valid region of the sonar volume.
subset	is the subset related to excusion of vessel realted noise such as wake.
dimvbsc	are the dimenstions of the acoustic data.
segfilesdir	is the directory of the segmentation files to be written.
sfnr	is the segmentatino file number.
dBan	is the dB above background.
dBb1	dBb2, dBb3, dBb4, dBbs are the dB belov the signal, where the first four are parameters in the function f(S, SBR, Sv) with dBb1 being the constant term.
Xsbg	Xsb1 are vectors of the smoothed background estimate (noise is the median over consecutive pings and Gaussian kernel smoothed along beams, whereas Xsb1 is not).
thisthr	is a vector of the above background-thresholds.
thersholdFromSchool	is the (unbiased) threshold values defined from the singal.
Xcsz	is the circular size of the schools, calucated as 2*sqrt(A/pi).
save.trh	is TRUE to save the threshold values used in the segmentation.
save.data	is TRUE to save the data included in the segmentation mask.
kern	is the standard deviation in units of the number of voxels used in a Gaussian kernel smoother along the beams (no smoothing if kern == 0 or length(kern) == 0, which is the default). If given as an integer, say 5L, median smoothing is applied instead of Gaussian.
wt	is the number of time steps used as the width of the median filter along time steps.
type	is the function to use across beams (one of "mean" and "median", where "mean" is used in PROFUS up to 2014, while "median" is more robust to the valus of the school).
cmpred	is a three column matrix holding the centers of mass of the ellipsoid outside which no samples are discarded from the segmentation mask. This matrix must have one row per time step, starting at the first time step.
ellipsoid	is an optional vector of up to three elements specifying the semi axes of an ellipsoid centered at the center of mass of a user selected region, outside which voxels will not be included in the segmentation. The ellispoid can be set to move with the center of mass of the segmented voxels.
file_thist	is the time index in the block. If this is equal to 'thist', a new file will be written. Otherwise data will be appended to the file with name given by 'file_thist'.
reserve	is used in write.TSD() to reserve time steps for the whole block of time steps.

arnejohannesholmin/cpplot3d documentation built on April 14, 2024, 11:36 p.m.