get_mass_props_and_unc_and_radii_and_unc: Get mass properties and uncertainties and radii of gyration...

View source: R/radii.R

get_mass_props_and_unc_and_radii_and_uncR Documentation

Get mass properties and uncertainties and radii of gyration and uncertainties

Description

get_mass_props_and_unc_and_radii_and_unc() creates a mass properties and uncertainties and radii of gyration and uncertainties list from a selected row in a data frame.

Usage

get_mass_props_and_unc_and_radii_and_unc(df, id)

Arguments

df

A data frame with (at least) these columns: id, mass, Cx, Cy, Cz, Ixx, Iyy, Izz, Ixy, Ixz, Iyz, POIconv, Ipoint, sigma_mass, sigma_Cx, sigma_Cy, sigma_Cz,sigma_Ixy, sigma_Ixz, sigma_Iyz, kx, ky, kz, sigma_kx, sigma_ky, sigma_kz.

id

The id value of the desired row.

Value

A list with the following named elements:

  • mass Numeric mass.

  • center_mass Numeric 3-vector center of mass.

  • point Logical indicating point mass. The inertia of point masses is excluded from calculations.

  • inertia Numeric 3x3 matrix inertia tensor. The signs of the off-diagonal elements of the inertia tensor are determined by POIconv. For example, the xy element of the inertia tensor is Ixy if POIconv is "-"; it is -Ixy if POIconv is "+".

  • sigma_mass Numeric mass uncertainty.

  • sigma_center_mass Numeric 3-vector center of mass uncertainties.

  • sigma_inertia Numeric 3x3 matrix inertia tensor uncertainties.

  • radii_gyration Numeric 3-vector radii of gyration.

  • sigma_radii_gyration Numeric 3-vector radii of gyration uncertainties.

Examples

mp_table_small_rollup <- rollup_mass_props_and_unc(mp_tree_small, mp_table_small)
radii_and_unc_table <- rollup_radii_of_gyration_unc(
                          mp_tree_small, add_radii_of_gyration(mp_table_small_rollup))
get_mass_props_and_unc_and_radii_and_unc(radii_and_unc_table, "C.1")


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