lineSegment-methods: Methods for "'lineSegment'" object creation in Package...

In sampSurf: Sampling Surface Simulation for Areal Sampling Methods

Description

There is currently only one method based on the lineSegment generic that is used for object construction. It is detailed below.

Methods

signature(length = "numeric", orientation = "numeric")

This method takes the segment length and orientation as the signature arguments along with other optional aruments described as follows...

usage...

lineSegment(length,
            orientation,
            units = 'metric',
            spUnits = CRS(projargs=as.character(NA)),
            centerPoint = c(x=0, y=0),  
            description = 'line segment',
            spID = paste('ls',.StemEnv$randomID(),sep=':'),
            ...) 

• length: The length of the line segment in the appropriate units (feet for “English” or meters for “metric”).

• orientation: The line orientation from north as an azimuth in degrees; e.g. orientation=45.

• units: Either “English” or “metric”. These must be conformable with the projection in spUnits.

• spUnits: A valid CRS object specifying the Coordinate Reference System. This defaults to NA, which means you want to use your own user-defined system, say for a sample line located in the field.

• centerPoint: The location of the center of the line segment in the appropriate spatial units. This should be a numeric vector of length 2 with names "x" and "y".

• description: A character vector description of the tract.

• spID: Each object should have its own unique identifier that is used in constructing the Lines object for the segment. This becomes very important when combining individual line segments into a population. If nothing is supplied, a random ID is generated.

sampSurf documentation built on March 5, 2021, 5:06 p.m.