display.obj.links {espadon} | R Documentation |
Display patient objects links
Description
The display.obj.links
function displays a graph of
connections between objects of a patient.
The name of the objects corresponds to their modality (ct, mr, rtdose...)
followed by their position in their respective lists in the patient list objects.
Connected objects are linked by arrows. Objects sharing the same frame of reference
have the same color except for objects with warnings, errors or missing planes
which are all in grey.
Approved objects are circled in green.
By default, objects shapes are circles, except rtdose represented as squares.
Usage
display.obj.links(
pat,
obj.selected = NULL,
exclusion = NULL,
square = "rtdose",
group.by.connected.FoR = TRUE,
interactive = FALSE,
random.seed = 314
)
Arguments
pat |
"patient" class object, as loaded using load.patient.from.dicom, load.patient.from.Rdcm or toy.load.patient. |
obj.selected |
Dataframe (default to NULL) containing the objects already selected,
created by a previous call of |
exclusion |
Vector of patient file modalities that should not be displayed,
as for instance |
square |
Vector of patient file modalities that should be enclosed by a
square, as for instance |
group.by.connected.FoR |
Boolean. If |
interactive |
Boolean. If |
random.seed |
Positive Integer or |
Value
The function displays all patient objects, linked by an
arrow when they are connected or a line when they belongs to the same DICOM
object, and with a color and a shape depending on square
, group.by.connected.FoR
.
When interactive = TRUE
, it returns a dataframe of the selected objects,
or NULL if no object is selected.
Items are circled in green when the DICOM file has been approved. They are circled in red, when the DICOM series is incomplete (e.g. missing plan).
See Also
Examples
# loading of toy-patient objects
patient <- toy.load.patient (dxyz = c (5, 5, 5), beam.nb = 1)
display.obj.links (patient, group.by.connected.FoR = FALSE)
display.obj.links (patient, group.by.connected.FoR = TRUE)
display.obj.links (patient, group.by.connected.FoR = TRUE, random.seed=NULL)