summary.Lines3D: Return a summary of a 'Lines3D' 'object'

View source: R/ClassFunctions.R

summary.Lines3DR Documentation

Return a summary of a Lines3D object

Description

Returns the below information about the object:

call of the function defining the object, the defining vectors (i.e., initial and direction vectors), selected x, y, and z points on the line, equation of the line (in parametric form), and coefficients of the line.

Usage

## S3 method for class 'Lines3D'
summary(object, ...)

Arguments

object

An object of class Lines3D.

...

Additional parameters for summary.

Value

call of the function defining the object, the defining vectors (i.e., initial and direction vectors), selected x, y, and z points on the line, equation of the line (in parametric form), and coefficients of the line (for the form: x=x0 + A*t, y=y0 + B*t, and z=z0 + C*t).

See Also

print.Lines3D, print.summary.Lines3D, and plot.Lines3D

Examples

## Not run: 
P<-c(1,10,3); Q<-c(1,1,3);
vecs<-rbind(P,Q)
Line3D(P,Q,.1)
Line3D(P,Q,.1,dir.vec=FALSE)

tr<-range(vecs);
tf<-(tr[2]-tr[1])*.1
#how far to go at the lower and upper ends in the x-coordinate
tsq<-seq(-tf*10-tf,tf*10+tf,l=3) #try also l=10, 20 or 100

lnPQ3D<-Line3D(P,Q,tsq)
lnPQ3D
summary(lnPQ3D)

## End(Not run)


elvanceyhan/pcds documentation built on June 29, 2023, 8:12 a.m.