energy_neighbourhood: Calculate the neighbourhood energy

Description Usage Arguments Value Author(s) Examples

Description

This functions provides a method to calculate the neighbourhood energy on the complete lattice grid, or at a single point within the provided lattice grid.

Usage

1

Arguments

x

the lattice grid for which the energy is required

position

the linear index of the node for which energy is required

neighbourhoods

the neighbourhoods associated with the lattice grid

Value

the neighbourhood energy for the lattice or the specific node

Author(s)

Kevin Brosnan (kevin.c.brosnan@gmail.com)

Examples

1
2
3
 y <- matrix(sample(c(-1, 1), size = 16, prob = c(0.6, 0.4), replace = TRUE), nrow = 4)
 neigh <- neighbourhoods(x = y, order = 1, method = "Moore")
 energy <- energy_neighbourhood(x = y, position = -1, neighbourhoods = neigh)

significantstats/gatingfc documentation built on May 8, 2019, 8:48 a.m.