% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/graph_helpers.R
\name{perforated_grid_helpers}
\alias{perforated_grid_helpers}
\alias{keep.periodic.holes}
\alias{keep.staggered.windows}
\alias{keep.slit.channels}
\alias{keep.asymmetric.notches}
\title{Deterministic perforated-grid occupancy helpers}
\usage{
keep.periodic.holes(
  h,
  w = h,
  hole_period = 4,
  hole_height = 1,
  hole_width = hole_height,
  row_offset = 2,
  col_offset = 2
)

keep.staggered.windows(
  h,
  w = h,
  window_height = 1,
  window_width = 2,
  row_period = 4,
  col_period = 5,
  row_offset = 2,
  col_offset = 2
)

keep.slit.channels(
  h,
  w = h,
  orientation = c("vertical", "horizontal"),
  slit_period = 5,
  slit_width = 1,
  bridge_spacing = 4,
  bridge_size = 1,
  offset = 2
)

keep.asymmetric.notches(h, w = h, notch_depth = 3, notch_width = 2)
}
\arguments{
\item{h}{Number of rows.}

\item{w}{Number of columns. Defaults to \code{h}.}

\item{hole_period}{Spacing between periodic holes.}

\item{hole_height}{Height of each removed rectangular hole.}

\item{hole_width}{Width of each removed rectangular hole.}

\item{row_offset}{Starting row index for the first removed block.}

\item{col_offset}{Starting column index for the first removed block.}

\item{window_height}{Height of each staggered removed window.}

\item{window_width}{Width of each staggered removed window.}

\item{row_period}{Vertical spacing between staggered window bands.}

\item{col_period}{Horizontal spacing between staggered windows within a band.}

\item{orientation}{Whether slit channels run \code{"vertical"} or
\code{"horizontal"}.}

\item{slit_period}{Spacing between repeated slit channels.}

\item{slit_width}{Width of each slit channel.}

\item{bridge_spacing}{Spacing between preserved bridge segments.}

\item{bridge_size}{Size of each preserved bridge segment along a slit.}

\item{offset}{Starting row or column index for the first slit channel.}

\item{notch_depth}{Depth of each asymmetric notch cut from a boundary.}

\item{notch_width}{Width of the notched opening along that boundary.}
}
\value{
A logical occupancy matrix whose \code{TRUE} entries represent
  retained cells.
}
\description{
Convenience constructors for finite occupied grids with non-random holes or
channels. These matrices can be passed to \code{\link{edges.occupied.mesh}()}
or \code{\link{occupied.mesh.surface.graph}()}.
}
