clear {AMAPVox}

Clear voxel

Description

Clear a set of voxels. Clearing means that the state variables of the selected voxels are altered as if they were clear of any vegetation. Namely:

• number of echo set to zero

• intercepted beam surface set to zero (if variable is outputted)

• plant area density set to zero (if variable is outputted)

• transmittance set to one (if variable is outputted)

• any attenuation variable set to zero

Other state variables such as sampling intensity, mean angle, entering beam surface, etc. are unaltered. A cleared voxel is not the same as an unsampled voxel (not "crossed" by any beam).

Usage

clear(vxsp, vx)

## S4 method for signature 'VoxelSpace,data.table'
clear(vxsp, vx)

## S4 method for signature 'VoxelSpace,vector'
clear(vxsp, vx)

## S4 method for signature 'VoxelSpace,matrix'
clear(vxsp, vx)

Arguments

vxsp

a VoxelSpace object.

vx

(i, j, k) voxel coordinates as a data.table::data.table with i, j, k columns, a vector (i, j, k) or a matrix with i, j, k columns.

Examples

# load a voxel file
vxsp <- readVoxelSpace(system.file("extdata", "tls_sample.vox", package = "AMAPVox"))
# clear 1st voxel
clear(vxsp, c(0, 0, 0)) # clear 1st voxel
# clear butterflies
clear(vxsp, butterfly(vxsp))
# clear voxels with less than two hits
clear(vxsp, vxsp@data[nbEchos < 2])