display.beams: Beam statistics plot

View source: R/display-functions.R

display.beamsR Documentation

Beam statistics plot

Description

Beam statistics plot

Usage

display.beams(beams, plan = NULL, numeric = FALSE, show.plot = TRUE,
  file.name = NULL, height = 7, width = 7, dpi = 300,
  field.names = NULL)

Arguments

beams

The beams dataframe.

plan

The plan object.

numeric

Display a numeric ID for the fields (default uses a beamLine+angles code).

file.name

File name for saving the plot.

height

The height of the saved plot image (inches).

width

The width of the saved plot image (inches).

dpi

dpi of the saved image.

field.names

Optional vector of the names for the different fields

shot.plot

Show plot.

Value

If show.plot=FALSE, it returns a ggplot object.

See Also

Other Beams: add.field, convert.fluence2mu, convert.mu2fluence, create.beam, create.field, display.beamports, get.beams, get.ct.entrance.point, get.isocenter, get.rays, read.beams, write.beams


planit-group/Rplanit documentation built on Dec. 5, 2022, 11:10 p.m.