Skip to contents

Shift a face-region mask by a number of pixels

Source: R/shift_mask.R
shift_mask.Rd

Slides a logical mask along the two image axes and returns the shifted mask in the same shape as the input. Convenience wrapper around the manual recipe shown in vignette section 4.5 for tuning an elliptical make_face_mask() region ("full", "nose", "mouth", "upper_face", "lower_face") on a base image whose features sit a few pixels off the default geometry.

For the rectangle regions ("eyes", "left_eye", "right_eye"), prefer the region_bounds argument of make_face_mask(): passing region_bounds = c(row_min, row_max, col_min, col_max) in 0-1 image fractions is more precise than counting pixels and is the canonical tuning route for those regions.

Pixels shifted off the image are dropped, and the newly exposed edge is filled with FALSE (i.e., outside the mask).

Usage

shift_mask(mask, vertical = 0L, horizontal = 0L, img_dims = NULL)

Arguments

mask

Logical vector of length prod(img_dims) (column-major, as returned by make_face_mask()) or a logical matrix.

vertical, horizontal

Integer pixel offsets. Positive vertical moves the mask up (toward the top of the image), negative vertical moves it down. Positive horizontal moves the mask right, negative moves it left. Defaults are 0 (no shift).

img_dims

Integer c(nrow, ncol) (or a single integer for a square image). Required when mask is a vector; ignored when mask is already a matrix.

Value

Logical mask of the same shape as the input (matrix-in, matrix-out; vector-in, vector-out).

See also

make_face_mask() (the region_bounds route for the rectangle regions), plot_mask_overlay(), plot_face_mask().

Examples

# Reshape the default mouth mask, slide it up 20 pixels on a
# 256-pixel image (about 8% of the height), and confirm it
# still has the right number of TRUE pixels.
m <- make_face_mask(c(256L, 256L), region = "mouth")
shifted <- shift_mask(m, vertical = 20L, img_dims = c(256L, 256L))
identical(sum(m), sum(shifted))
#> [1] TRUE

# Matrix-in, matrix-out: shift up 20 and right 8.
mat <- matrix(m, 256L, 256L)
shifted_mat <- shift_mask(mat, vertical = 20L, horizontal = 8L)
dim(shifted_mat)
#> [1] 256 256