ssEnergy: Calcluate the "Average Energy" from a "sampSurf" Image

Description Usage Arguments Details Value Author(s) See Also Examples

Description

This will calculate the “average energy” surface for the “sampSurf” object slot in an “ssMODWT” or “ssCovMODWT” object. In the case case of covariance, this is simply the average covariance energy.

Usage

1
ssEnergy(ssMODWT, showPlot = TRUE, showIZs = TRUE, boxCol = "gray", col = NA, title = NA, ...)

Arguments

ssMODWT

Either a valid “ssMODWT” or “ssCovMODWT” object.

showPlot

TRUE: display the surface; FALSE: no display.

showIZs

TRUE: display the inclusion zones; FALSE: don't display.

boxCol

Outline color for perimeter box.

col

A vector palette of colors for the surface; see, e.g., palMODWT.

title

If showPlot, a title, or NA for nothing.

...

Gobbled.

Details

The “average energy” in a scene is essentially the mean sums of squares that is probably more familiar to most users. The former terminology is used by physicists.

The package vignette in the references below gives more information on this subject.

Value

A “Raster” object corresponding to the average energy.

Author(s)

Jeffrey H. Gove

See Also

covMODWT

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
#
# 1. creates a sampSurf object with horizontal point sampling
# 2. creates a J_0 = 3-level MODWT decomposition object
# 3. calculates the average energy of the surface...
#
tr = Tract(c(x = 64, y = 64), cellSize = 1) #square tract ~0.5ha
btr = bufferedTract(10, tr)
ag3m = angleGauge(3)        #metric BAF
sshps = sampSurf(10, btr, iZone = 'horizontalPointIZ', angleGauge = ag3m,
        topDiam = c(0,0), startSeed = 123)
modwt.hps = ssMODWT(sshps, J = 3)
ae = ssEnergy(modwt.hps, showPlot = FALSE) #showPlot=TRUE to display

ssWavelets documentation built on May 2, 2019, 5:54 p.m.