opynsim
Unofficial C++ Documentation
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
opyn::ModelWarper Class Referencefinal

#include <model_warper.h>

Public Member Functions

 ModelWarper ()
 
size_t num_scaling_steps () const
 
size_t num_scaling_parameters () const
 Returns the number of scaling parameters that this ModelWarper is parameterized by.
 
ModelSpecification warp (const ModelSpecification &model_specification) const
 

Static Public Member Functions

static ModelWarper from_xml (const std::filesystem::path &source)
 

Detailed Description

A solver that can warp ModelSpecifications by applying a sequence of ScalingSteps to an input ModelSpecification.

Constructor & Destructor Documentation

◆ ModelWarper()

opyn::ModelWarper::ModelWarper ( )
explicit

Constructs a blank ModelWarper with no ScalingSteps or scaling parameters.

Member Function Documentation

◆ from_xml()

static ModelWarper opyn::ModelWarper::from_xml ( const std::filesystem::path &  source)
static

Returns a ModelWarper read from source, which should be a path to an XML document that contains a ModelWarperV3Document (a legacy data structure, from OpenSim Creator's model warper). Throws an exception if there is an IO/parsing/validation error.

◆ num_scaling_parameters()

size_t opyn::ModelWarper::num_scaling_parameters ( ) const

Returns the number of scaling parameters that this ModelWarper is parameterized by.

◆ num_scaling_steps()

size_t opyn::ModelWarper::num_scaling_steps ( ) const

Returns the number of ScalingSteps performed by this ModelWarper when it warps a ModelSpecification.

◆ warp()

ModelSpecification opyn::ModelWarper::warp ( const ModelSpecification &  model_specification) const

Returns a warped copy of model_specification.

Parameters
model_specificationThe source ModelSpecification that should be copied and warped by this ModelWarper.

The documentation for this class was generated from the following file: