s2cap: Define spherical cap

View source: R/s2region.R

s2capR Documentation

Define spherical cap

Description

Define spherical cap

Usage

s2cap(axis, height, dist, ..., simplify = TRUE)

Arguments

axis

Axis (or centre) of the cap in a format acceptable to s2point.

height

Numeric of length one defining the height of the cap. Should be positive and at most twice the radius of the sphere. Not compatible with dist.

dist

Numeric of length one defining the extend of the cap. All points on the sphere within distance dist of the point defined by axis are contained in the cap. Not compatible with height.

...

Arguments passed on to s2

radius

Numeric. Defaults to 1. For convenience this can also be an object of class "s2region" from where the radius and unitname then will be extracted.

unitname

Optional. Name of unit of length. Either a single character string, or a vector of two character strings giving the singular and plural forms, respectively.

simplify

Logical. Whether to simplify to full sphere if the cap extends over the full sphere.

Value

Object of class "s2cap" and "s2region".


spatstat/spatstat.sphere documentation built on Jan. 27, 2023, 2:59 a.m.