retistruct (version 0.6.3)

OutlineCommon: Class containing functionality common to flat and reconstructed outlines

Description

An OutlineCommon has functionality for retrieving sets of features (e.g. points or landmarks associated with an outline)

Public fields

version

Version of reconstruction file data format

featureSets

List of feature sets associated with the outline, which may be of various types, e.g. a PointSet or LandmarkSet

Methods

Public methods

• OutlineCommon$getFeatureSets()

• OutlineCommon$getFeatureSet()

• OutlineCommon$clearFeatureSets()

• OutlineCommon$getIDs()

• OutlineCommon$getFeatureSetTypes()

• OutlineCommon$clone()

Method getFeatureSets()

Get all the feature sets

Usage

OutlineCommon$getFeatureSets()

Returns

List of FeatureSets associated with the outline

Method getFeatureSet()

Get all feature sets of a particular type, e.g. PointSet or LandmarkSet

Usage

OutlineCommon$getFeatureSet(type)

Arguments

type

The type of the feature set as a string

Returns

All FeatureSets of that type

Method clearFeatureSets()

Clear all feature sets from the outline

Usage

OutlineCommon$clearFeatureSets()

Method getIDs()

Get all the distinct IDs contained in the FeatureSets

Usage

OutlineCommon$getIDs()

Returns

Vector of IDs

Method getFeatureSetTypes()

Get all the distinct types of FeatureSets

Usage

OutlineCommon$getFeatureSetTypes()

Returns

Vector of types as strings, e.g. PointSet, LandmarkSet

Method clone()

The objects of this class are cloneable with this method.

Usage

OutlineCommon$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.