eddies: Main function: import eddies data into R

In SESman/eddies: Global Ocean Eddies Database

Description

Main function: import eddies data into R

Usage

eddies(date, type = c("both", "cyc", "antcyc"), ...)

Arguments

date	Date of the eddy
type	Type of the eddy
...	Other arguments to be passed to read_eddy.

Details

• Area: the number of pixels in the eddy feature

• MajorAxisLength: Scalar specifying the length (in pixels) of the major axis of the eddy feature that has the same normalized second central moments as the eddy region.

• MinorAxisLength: the length (in pixels) of the minor axis of the eddy that has the same normalized second central moments as the eddy region.

• Orientation: the angle (in degrees ranging from -90 to 90 degrees) between the x-axis and the major axis of the eddy that has the same second-moments as the eddy region.

• ConvexImage: Binary image (0 or 1) that specifies the convex hull, with all pixels within the hull filled in (i.e., set to on). A Convex Hull is minimal set that can contain a set of pixels

• Extrema: 8-by-2 matrix that specifies the extrema points in the region

• Solidity: Scalar specifying the proportion of the pixels in the convex hull that are also in the feature. This tell us how compact or distorted the feature is

• Extent: Scalar that specifies the ratio of pixels in the region to pixels in the total bounding box.

• PixelIdList: p-element vector containing the linear indices of the pixels the form of the eddy's body

• Intensity the maximum (for anticyclonic) or minimum (for cyclonic) SLA value within the eddy

• Lat: the latitude value of eddy centroid.

• Lon: the longitude value of eddy centroid.

• Amplitude: the magnitude of the difference between the estimated basal height of the eddy boundary and the extremum value of SLA within the eddy interior.

• ThreshFound: thresholding value when the eddy was found.

• SurfaceArea: The surface area in squared kilometers

• Date: the date eddy was found.

• MeanGeoSpeed: the mean geostrophic speed computed from the SLA anomalies within the eddy's contour

• Cyc: the eddy's rotational direction -1 for cyclonic, 1 for anti-cyclonic.

References

Faghmous, J. H., Frenger, I., Yao, Y., Warmka, R., Lindell, A. and Kumar, V. (2015). A daily global mesoscale ocean eddy dataset from satellite altimetry. Scientific Data 2, 150028.

See Also

select_eddy, read_eddy

Examples

## Not run: 
days <- as.POSIXct(c("2010-01-01", "2011-01-01"))
edd <- eddies(days)

## End(Not run)

SESman/eddies documentation built on May 9, 2019, 11:10 a.m.