unfoldr (version 0.7.1)

sectionProfiles: Construct section profiles

Description

Set up section profiles of spheroids for unfolding

Usage

sectionProfiles(size, alpha, type = c("prolate", "oblate"))

Arguments

size

matrix of lengths of the semi-axes

alpha

angle of section profiles in the plane (see details)

type

name of the spheroid type, either "prolate" or "oblate" from which the section profiles are assumed to come from

Value

The function returns a list which consists of either the longer or shorter semi-axis length named A of section profiles corresponding to the type of spheroids used before and whose joint joint distribution is to be estimated (by unfolding), the shape factor S of both semi-axes as the shape factor between \((0,1]\) and the orientation angle alpha, either of class "prolate" or "oblate".

Details

The function aggregates the necessary information for trivariate unfolding of spheroids' joint size-shape orientation distribution of type either "prolate" or "oblate". The argument size is a numeric matrix of semi-axis lengths where the first column corresponds to the major semi-axis and the second one to minor semi-axis. The orientation of an ellipse is assumed to be measured as the angle between its major axis and vertical axis of the coordinate system in the intersection plane ('z' axis in 3D). For values in \([0,2\pi]\) these angles are automatically transformed to \([0,\pi/2]\) as required by the unfolding procedure.

Examples

# NOT RUN {
 # load data set
 data(data15p)
 
 # matrix of semi-axes lengths (major,minor)
 AC <- data.matrix(data15p[c("A","C")])/1000	

 # selecting the minor semi-axis for prolate type of spheroids:
 # independent of nomenclature (always named \code{A})
 sp <- sectionProfiles(AC,unlist(data15p["alpha"]))

 summary(sp$A)			# here minor semi-axis because of prolate
 summary(sp$S)			# shape factor
 summary(sp$alpha)		# angle assumed to be w.r.t. (vertical) 'z' axis 
 
# }