retistruct (version 0.6.3)

FeatureSet: Superclass containing functions and data relating to sets of features in flat Outlines

Description

A FeatureSet contains information about features located on Outlines. Each FeatureSet contains a list of matrices, each of which has columns labelled X and Y describing the cartesian coordinates of points on the Outline, in the unscaled coordinate frame. Derived classes, e.g. a CountSet, may have extra columns. Each matrix in the list has an associated label and colour, which is used by plotting functions.

Super class

retistruct::FeatureSetCommon -> FeatureSet

Methods

Public methods

• FeatureSet$new()

• FeatureSet$clone()

• retistruct::FeatureSetCommon$getCol()

• retistruct::FeatureSetCommon$getFeature()

• retistruct::FeatureSetCommon$getFeatures()

• retistruct::FeatureSetCommon$getIDs()

• retistruct::FeatureSetCommon$getIndex()

• retistruct::FeatureSetCommon$setID()

Method new()

Constructor

Usage

FeatureSet$new(data = NULL, cols = NULL, type = NULL)

Arguments

data

List of matrices describing data. Each matrix should have columns named X and Y

cols

Named vector of colours for each data set. The name is used as the ID (label) for the data set. The colours should be names present in the output of the colors function

type

String

Method clone()

The objects of this class are cloneable with this method.

Usage

FeatureSet$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.