% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/classes.R
\docType{class}
\name{HexGridInfo-class}
\alias{HexGridInfo-class}
\title{HexGridInfo Class}
\description{
An S4 class representing a hexagonal grid specification. Stores all
parameters needed for grid operations.
}
\details{
Create HexGridInfo objects using the \code{\link{hex_grid}} constructor function.
Do not use \code{new("HexGridInfo", ...)} directly.

The aperture can be "3", "4", "7" for grids that refine by one aperture at
every level; a family name such as "4/3" or "4/7", which refines by the first
aperture for the first floor(resolution / 2) levels and by the second for the
rest; or one aperture per level, "4/4/7/3".

For H3 grids, the aperture is fixed at "7" and resolution ranges from 0 to 15.
}
\section{Slots}{

\describe{
\item{\code{aperture}}{Character. Grid aperture: "3", "4", "7", a mixed family such
as "4/3" or "4/7", or one aperture per resolution level ("4/4/7/3").}

\item{\code{resolution}}{Integer. Grid resolution level (0-30 for ISEA, 0-15 for H3).}

\item{\code{area_km2}}{Numeric. Cell area in square kilometers.}

\item{\code{diagonal_km}}{Numeric. Cell diagonal (long diagonal) in kilometers.}

\item{\code{crs}}{Integer or character. Coordinate reference system: an EPSG code,
or a 'PROJ' or 'WKT' string. Defaults to 'WGS84' on Earth, and to a longlat
CRS on the sphere of \code{radius_km} on any other body.}

\item{\code{grid_type}}{Character. Grid system: "isea" (default) or "h3".}

\item{\code{radius_km}}{Numeric. Radius of the body the grid covers, in kilometers.
\code{NA} reads as Earth's mean radius.}
}}

\seealso{
\code{\link{hex_grid}} for the constructor function,
\code{\link{HexData-class}} for hexified data objects
}
