Python package piper.anatomyDB

The piper.anatomyDB python package gives access to anatomy database queries. More...

Classes
class	anatomydb::LandmarkCont
	An interface class to store the landmark positions to anatomydb::FrameFactory. More...
class	anatomydb::Frame
	Store coordinates of a frame. More...
class	anatomydb::FrameFactory
	This class computes anatomical frames coordinate from landmark positions. More...

Functions
void	anatomydb::init (std::string const &databaseFile="")
	Initialize the database. More...

Queries
These functions are the available queries to the anatomical database.
unsigned int	anatomydb::getEntityId (std::string const &name)
std::string	anatomydb::getReferenceName (std::string const &name)
bool	anatomydb::isSynonymOf (std::string const &name1, std::string const &name2)
std::string	anatomydb::getReferenceNameNoThrow (std::string const &name)
std::string	anatomydb::getEntityDescription (std::string const &name)
bool	anatomydb::exists (std::string const &name)
bool	anatomydb::isBone (std::string const &name)
bool	anatomydb::isSkin (std::string const &name)
bool	anatomydb::isLandmark (std::string const &name)
bool	anatomydb::isEntitySubClassOf (std::string const &name, std::string const &className)
bool	anatomydb::isEntityPartOf (std::string const &entity, std::string const &parent, bool recursive=false)
bool	anatomydb::isEntityFromBibliography (std::string const &entity, std::string const &bibliography)
std::vector< std::string >	anatomydb::getSubClassOfList (std::string const &className)
std::vector< std::string >	anatomydb::getParentClassList (std::string const &name)
std::vector< std::string >	anatomydb::getPartOfList (std::string const &name)
std::vector< std::string >	anatomydb::getPartOfList (std::string const &name, std::string const &className)
std::vector< std::string >	anatomydb::getSubPartOfList (std::string const &name, std::string const &className, bool recursive=false)
std::vector< std::string >	anatomydb::getSynonymList (std::string const &name, bool omitReferenceName=false)
std::string	anatomydb::getSynonymFromBibliography (std::string const &name, std::string const &fromBibliography)
std::vector< std::string >	anatomydb::getEntityBibliographyList (std::string const &name)
std::vector< std::string >	anatomydb::getLandmarkBoneList (std::string const &name)
std::vector< std::string >	anatomydb::getSubClassOfFromBibliographyList (std::string const &className, std::string const &bibliography)
std::vector< std::string >	anatomydb::getAnatomicalEntityList ()
std::vector< std::string >	anatomydb::getLandmarkList ()
std::vector< std::string >	anatomydb::getJointList ()

Detailed Description

The piper.anatomyDB python package gives access to anatomy database queries.

Function Documentation

bool anatomydb::exists

(

std::string const &

name

)

std::vector<std::string> anatomydb::getAnatomicalEntityList

(

)

std::vector<std::string> anatomydb::getEntityBibliographyList

(

std::string const &

name

)

std::string anatomydb::getEntityDescription

(

std::string const &

name

)

unsigned int anatomydb::getEntityId

(

std::string const &

name

)

std::vector<std::string> anatomydb::getJointList

(

)

std::vector<std::string> anatomydb::getLandmarkBoneList

(

std::string const &

name

)

std::vector<std::string> anatomydb::getLandmarkList

(

)

std::vector<std::string> anatomydb::getParentClassList

(

std::string const &

name

)

std::vector<std::string> anatomydb::getPartOfList

(

std::string const &

name

)

std::vector<std::string> anatomydb::getPartOfList	(	std::string const &	name,
		std::string const &	className
	)

std::string anatomydb::getReferenceName

(

std::string const &

name

)

std::string anatomydb::getReferenceNameNoThrow

(

std::string const &

name

)

std::vector<std::string> anatomydb::getSubClassOfFromBibliographyList	(	std::string const &	className,
		std::string const &	bibliography
	)

std::vector<std::string> anatomydb::getSubClassOfList

(

std::string const &

className

)

std::vector<std::string> anatomydb::getSubPartOfList	(	std::string const &	name,
		std::string const &	className,
		bool	recursive = false
	)

std::string anatomydb::getSynonymFromBibliography	(	std::string const &	name,
		std::string const &	fromBibliography
	)

std::vector<std::string> anatomydb::getSynonymList	(	std::string const &	name,
		bool	omitReferenceName = false
	)

void anatomydb::init

(

std::string const &

databaseFile = ""

)

Initialize the database.

When used in the Piper application, the database is already initialized.

Parameters

databaseFile

optionnal path to the database file.

bool anatomydb::isBone

(

std::string const &

name

)

bool anatomydb::isEntityFromBibliography	(	std::string const &	entity,
		std::string const &	bibliography
	)

bool anatomydb::isEntityPartOf	(	std::string const &	entity,
		std::string const &	parent,
		bool	recursive = false
	)

bool anatomydb::isEntitySubClassOf	(	std::string const &	name,
		std::string const &	className
	)

bool anatomydb::isLandmark

(

std::string const &

name

)

bool anatomydb::isSkin

(

std::string const &

name

)

bool anatomydb::isSynonymOf	(	std::string const &	name1,
		std::string const &	name2
	)