FeatureSetCommon: Class containing functionality common to 'FeatureSet's and...

Description Public fields Methods Author(s)

Description

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

Public fields

data

List of matrices describing data

cols

Vector of colours for each data set

type

String giving type of feature set

Methods

Public methods


Method getIndex()

Get numeric index of features

Usage
FeatureSetCommon$getIndex(fid)
Arguments
fid

Feature ID (string)


Method getIDs()

Get IDs of features

Usage
FeatureSetCommon$getIDs()
Returns

Vector of IDs of features


Method setID()

Set name

Usage
FeatureSetCommon$setID(i, fid)
Arguments
i

Numeric index of feature

fid

Feature ID (string)


Method getFeature()

Get feature by feature ID

Usage
FeatureSetCommon$getFeature(fid)
Arguments
fid

Feature ID string

Returns

Matrix describing feature


Method getFeatures()

Get all features

Usage
FeatureSetCommon$getFeatures()

Method getCol()

Get colour in which to plot feature ID

Usage
FeatureSetCommon$getCol(fid)
Arguments
fid

Feature ID string


Method clone()

The objects of this class are cloneable with this method.

Usage
FeatureSetCommon$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Author(s)

David Sterratt


retistruct documentation built on April 4, 2020, 5:08 p.m.