set_poi_conv_plus: Set POI sign convention for mass properties list to "+"

In massProps: Calculate Mass Properties and Uncertainties of Tree Structures

Set POI sign convention for mass properties list to "+"

Description

set_poi_conv_plus() sets the products of inertia sign convention for a mass properties list to "+". This convention determines how products of inertia are saved to a data set.

The signature of set_poi_conv_plus() is such that it can be passed as an override argument to update_mass_props() and update_mass_props_and_unc(), thus ensuring that calculated POI values are saved using the positive integral convention.

Usage

set_poi_conv_plus(ds, target, mp)

Arguments

ds	Ignored.
target	Ignored.
mp	A mass properties list.

Value

The input mass properties list with the named element poi_conv set to "+"

Examples

set_poi_conv_plus(NULL, NULL, get_mass_props(mp_table, "C.1.2.2.3.2.1.1"))

massProps documentation built on April 4, 2025, 1:45 a.m.