View source: R/echoSegment.TSD.R

Extracts a subvolume of the data enclosed in the bounding box or ellipsoid specified in the input, and calculates the total echo energy in the subvolume. Optionally the bounding object is plotted on top of an existing plot.

1 2 3 |

`data` |
is a list containing the acoustic data and the vessel data, as returned from read.event(var=c("vbsc","voxels","vessel")). |

`object` |
is string representing the type of object to use. Currently implemented are "ellipsoid" and "cuboid" (may be abbreviated). |

`par` |
is a vector of three elements representing the semi axis lengths for ellipsoid and the x-width, y-depth and z-height of cuboid. |

`center` |
is a vector of three elements representing the centre position of the object. |

`angle` |
is the angle of the major axis of the ellipsoid in the x-y-plane, in the case that object=="ellipsoid". |

`plot` |
is TRUE if the object should be plotted as an rgl-object. |

`seg.col` |
is the color of the object in case plot==TRUE. |

`alpha` |
is the transparacy of the object in case plot==TRUE. |

`subdivide` |
is the density of points on the plotted ellipsoid. |

`excl.neg` |
is FALSE if negative mass values are to be included in the calculation of the centers of mass of the school. |

`full.out` |
is TRUE to return voxel positions, volumes and acoustic data inside the segmente, as well as the segmentation mask. |

Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.