Python package piper.app

The piper.app python package gives access to application related data structures and functions. More...

Classes
class	piper::Context
	Application context. More...
class	piper::Project
	Piper project. More...
class	piper::ModuleParameter
	A piper::Project module parameters. More...

Functions
std::string	piper::tempDirectoryPath (std::string const &module="")
	Get the application specific temporary path. More...

Logging
These functions send a message to the application log, using the corresponding level.
void	piper::logDebug (std::string const &message)
void	piper::logInfo (std::string const &message)
void	piper::logWarning (std::string const &message)
void	piper::logError (std::string const &message)
void	piper::logSuccess (std::string const &message)
void	piper::logStart (std::string const &message)
void	piper::logDone (std::string const &message="")

Application signals
These functions send a signal to the application to indicate some thing has changed. You should call the appropriate function if you modify the model or targets, they will make the application (display, internal data,...) update accordingly. Warning In batch mode these functions are not available
void	piper::modelUpdated ()
	Call it after you change any nodes coordinates. More...
void	piper::metadataChanged ()
	Call it after you change some metadata. More...
void	piper::targetChanged ()
	Call it after you change some target. More...
void	piper::historyListChanged ()
	Call it after you change project history. More...

Modules specific functions
PIPERCOMMON_EXPORT void	piper::physPosiDeform (piper::Project &model, piper::hbm::TargetList const &target)
	This function applies the physics based positioning deformation to model using target. More...
PIPERCOMMON_EXPORT void	piper::applyTargetScalingParameter (piper::Project &model, piper::hbm::TargetList const &target)
	This function defines scaling parameter value defined in target to model. More...
PIPERCOMMON_EXPORT void	piper::readContourCL (piper::hbm::FEModel &c_fem, piper::hbm::Metadata &c_meta)
	This function defines reads the contourCL.xml file and populates the contourCL datastructs. More...
PIPERCOMMON_EXPORT void	piper::importSimplifiedScalableModel (piper::Project &project, std::string const &filepath)
	This function import Simplified Scalable Model from filepath in the project. More...
PIPERCOMMON_EXPORT void	piper::applyScalingTarget (piper::Project &project, piper::hbm::TargetList const &target, bool const &useKrigingWIntermediates=true)
	This function applies anthropometric dimension target and landmark targets in target to model project useKrigingWIntermediates: set true if intermediates target skin and bones are used for transformation. More...

Detailed Description

The piper.app python package gives access to application related data structures and functions.

Function Documentation

PIPERCOMMON_EXPORT void piper::applyScalingTarget	(	piper::Project &	project,
		piper::hbm::TargetList const &	target,
		bool const &	useKrigingWIntermediates = true
	)

This function applies anthropometric dimension target and landmark targets in target to model project useKrigingWIntermediates: set true if intermediates target skin and bones are used for transformation.

PIPERCOMMON_EXPORT void piper::applyTargetScalingParameter	(	piper::Project &	model,
		piper::hbm::TargetList const &	target
	)

This function defines scaling parameter value defined in target to model.

void piper::historyListChanged

(

)

Call it after you change project history.

PIPERCOMMON_EXPORT void piper::importSimplifiedScalableModel	(	piper::Project &	project,
		std::string const &	filepath
	)

This function import Simplified Scalable Model from filepath in the project.

void piper::logDebug

(

std::string const &

message

)

void piper::logDone

(

std::string const &

message = ""

)

void piper::logError

(

std::string const &

message

)

void piper::logInfo

(

std::string const &

message

)

void piper::logStart

(

std::string const &

message

)

void piper::logSuccess

(

std::string const &

message

)

void piper::logWarning

(

std::string const &

message

)

void piper::metadataChanged

(

)

Call it after you change some metadata.

void piper::modelUpdated

(

)

Call it after you change any nodes coordinates.

PIPERCOMMON_EXPORT void piper::physPosiDeform	(	piper::Project &	model,
		piper::hbm::TargetList const &	target
	)

This function applies the physics based positioning deformation to model using target.

PIPERCOMMON_EXPORT void piper::readContourCL	(	piper::hbm::FEModel &	c_fem,
		piper::hbm::Metadata &	c_meta
	)

This function defines reads the contourCL.xml file and populates the contourCL datastructs.

void piper::targetChanged

(

)

Call it after you change some target.

std::string piper::tempDirectoryPath

(

std::string const &

module = ""

)

Get the application specific temporary path.

The module parameter can create a specific sub directory in that path.

Warning

This temporary folder is erased at application exit.