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

View source: R/ClassFunctions.R

summary.PlanesR Documentation

Return a summary of a Planes object

Description

Returns the below information about the object:

call of the function defining the object, the defining 3D points, selected x, y, and z points on the plane, equation of the plane, and coefficients of the plane.

Usage

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

Arguments

object

An object of class Planes.

...

Additional parameters for summary.

Value

The call of the object of class "Planes", the defining 3D points, selected x, y, and z points on the plane, equation of the plane, and coefficients of the plane (in the form: z = A*x + B*y + C).

See Also

print.Planes, print.summary.Planes, and plot.Planes

Examples

## Not run: 
P<-c(1,10,3); Q<-c(1,1,3); C<-c(3,9,12)
pts<-rbind(P,Q,C)

xr<-range(pts[,1]); yr<-range(pts[,2])
xf<-(xr[2]-xr[1])*.1
#how far to go at the lower and upper ends in the x-coordinate
yf<-(yr[2]-yr[1])*.1
#how far to go at the lower and upper ends in the y-coordinate
x<-seq(xr[1]-xf,xr[2]+xf,l=5) #try also l=10, 20 or 100
y<-seq(yr[1]-yf,yr[2]+yf,l=5) #try also l=10, 20 or 100

plPQC<-Plane(P,Q,C,x,y)
plPQC
summary(plPQC)

## End(Not run)


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