op_plot_openpose: Plot OpenPose Data for a Specified Frame

View source: R/op_plot_openpose.R

op_plot_openposeR Documentation

Plot OpenPose Data for a Specified Frame

Description

This function visualizes keypoints and their connections from OpenPose data for a specified frame. The function allows customization of the plot, including the option to display labels, lines between keypoints, and different colours for left and right persons.

Usage

op_plot_openpose(
  data,
  frame_num,
  person = c("both", "left", "right"),
  lines = TRUE,
  keylabels = FALSE,
  label_type = c("names", "numbers"),
  hide_labels = FALSE,
  left_color = "blue",
  right_color = "red",
  background_color = "white",
  background_colour = NULL,
  line_width = 2,
  point_size = 1.5,
  text_color = "black"
)

Arguments

data

A data frame containing OpenPose data. The data frame should include columns for the frame number, person identifier, and x/y coordinates for each keypoint.

frame_num

A numeric value specifying the frame number to plot.

person

A character string specifying which person to plot: "left", "right", or "both". Default is "both".

lines

A logical value indicating whether to draw lines between keypoints. Default is TRUE.

keylabels

A logical value indicating whether to display keypoint labels. Default is FALSE.

label_type

A character string specifying the type of labels to display: "names" or "numbers". Default is "names".

hide_labels

A logical value indicating whether to hide axis labels and plot titles. Default is FALSE.

left_color

A character string specifying the color for the left person. Default is "blue".

right_color

A character string specifying the color for the right person. Default is "red".

background_color

A character string specifying the background color of the plot. Default is "white".

background_colour

A character string specifying the background colour of the plot (UK spelling). Default is NULL.

line_width

A numeric value specifying the width of the lines between keypoints. Default is 2.

point_size

A numeric value specifying the size of the keypoint markers. Default is 1.5.

text_color

A character string specifying the color of the text (labels and titles). Default is "black".

Value

No return value, called for side effects (plotting to screen).

Examples

# Path to example CSV file included with the package
file_path <- system.file("extdata/csv_data/A-B_body_dyad.csv", package = "duet")

# Load the data
data <- read.csv(file_path)

# Plot the data for the specified frame
op_plot_openpose(
  data = data,
  frame_num = 1,
  person = "both",
  lines = TRUE,
  keylabels = TRUE,
  label_type = "names",
  left_color = "blue",
  right_color = "red",
  background_colour = "grey90"
)


duet documentation built on April 3, 2025, 5:52 p.m.

Related to op_plot_openpose in duet...