Utils

files

pyCGM2.Utils.files.copyPaste(src, dst)

file copy/paste

Parameters

• src (str) – source

• dst (str) – destination

pyCGM2.Utils.files.copyPasteDirectory(src, dst)

folder copy/paste

Parameters

• src (str) – source

• dst (str) – destination

pyCGM2.Utils.files.copySessionFolder(folderPath, folder2copy, newFolder, selectedFiles=None)

copy a vicon-session folder

Parameters

• folderPath (str) – new session folder path

• folder2copy (str) – session folder path to copy

• selectedFiles (str,Optional[none]) – selected files to copy

pyCGM2.Utils.files.createDir(fullPathName)

Create a folder

Parameters

fullPathName (str) – path

pyCGM2.Utils.files.deleteDirectory(dir)

Delete a folder

Parameters

dir (str) – folder path

pyCGM2.Utils.files.getC3dFiles(path, text='', ignore=None)

get all c3d files in a folder

Parameters

• path (str) – folder path

• text (str,Optional[""]) – included text in the filename

pyCGM2.Utils.files.getDirs(folderPath)

get all folders

Parameters

folderPath (str) – folder path

pyCGM2.Utils.files.getFileCreationDate(file)

return file creation date

Parameters

file (str) – full filename (path+filename)

pyCGM2.Utils.files.getFiles(path, extension, ignore=None, raiseFlag=False)

get all files in a folder

Parameters

• path (str) – folder path

• extension (str) – file extension

• ignore (str,Optional[None]) – ignored filenames

• raiseFlag (bool,Optional[False]) – raise exception

pyCGM2.Utils.files.getIKweightSet(DATA_PATH, ikwf)

get marker weights for kinematic fitting

Parameters

• DATA_PATH (str) – data folder path

• ikwf (str) – weights filename

pyCGM2.Utils.files.getMp(mpInfo, resetFlag=True)

return required and optional anthropometric parameters

Parameters

• mpInfo (dict) – global mp dictionary

• resetFlag (bool,Optional[True]) – reset optional parameters

pyCGM2.Utils.files.getMpFileContent(DATA_PATH, file, subject)

get anthropometric data

Parameters

• DATA_PATH (str) – data folder path

• file (str) – Filename

• subject (str) – subject name

pyCGM2.Utils.files.getTranslators(DATA_PATH, translatorType='CGM1.translators')

get CGM marker translators

Parameters

• DATA_PATH (str) – data folder path

• translatorType (str,Optional[CGM1.translators]) – translator filename

pyCGM2.Utils.files.loadAnalysis(path, FilenameNoExt)

load an analysis instance

Parameters

• path (str) – data folder path

• FilenameNoExt (str) – analysis filename without extension

pyCGM2.Utils.files.loadModel(path, FilenameNoExt)

load a pyCGM2 model instance

Parameters

• path (str) – data folder path

• FilenameNoExt (str) – model filename wthout extension

pyCGM2.Utils.files.loadModelSettings(DATA_PATH, expertsettings_filename)

Load a pyCGM2 model settings.

Parameters

• DATA_PATH (str) – data folder path

• expertsettings_filename (str) – setting filename

pyCGM2.Utils.files.openFile(path, filename)

open a json/yaml file.

Parameters

• path (str) – data folder path

• filename (str) – filename with Extension

pyCGM2.Utils.files.openPickleFile(path, filename)

open a serialized file.

Parameters

• path (str) – data folder path

• filename (str) – filename with Extension

pyCGM2.Utils.files.readContent(stringContent)

read a json/yaml content

Parameters

stringContent (str) – json or yaml content

pyCGM2.Utils.files.readXml(DATA_PATH, filename)

Read a xml file

Parameters

• DATA_PATH (str) – folder path

• filename (str) – xlm filename

pyCGM2.Utils.files.saveAnalysis(analysisInstance, path, FilenameNoExt)

save a pyCGM2 analysis instance

Parameters

• pyCGM2.Processing.analysis.Analysis) (model) – an analysis instance

• path (str) – data folder path

• FilenameNoExt (str) – model filename wthout extension

pyCGM2.Utils.files.saveJson(path, filename, content, ensure_ascii=False)

save as json file

Parameters

• path (str) – data folder path

• filename (str) – json filename

• content (dict) – dictionary to save

pyCGM2.Utils.files.saveModel(model, path, FilenameNoExt)

save a pyCGM2 model instance

Parameters

• pyCGM2.Model.model.Model) (model) – a model instance

• path (str) – data folder path

• FilenameNoExt (str) – model filename wthout extension

pyCGM2.Utils.files.saveMp(mpInfo, model, DATA_PATH, mpFilename)

Save anthropometric parameters as json

Parameters

• mpInfo (dict) – global anthropometric parameters

• model (pyCGM2.Model.model.Model) – a model instance

• DATA_PATH (str) – data folder path

• mpFilename (str) – filename

pyCGM2.Utils.files.savePickleFile(instance, path, filename)

serialized a pyCGM2 instance , then save it.

Parameters

• instance (object) – a object instance

• path (str) – data folder path

• filename (str) – filename with Extension

utils

pyCGM2.Utils.utils.isInRange(val, min, max)

check if value is in range

Parameters

• val (double) – value

• min (double) – minimim value

• max (double) – maximum value

pyCGM2.Utils.utils.toBool(text)

convert text to bool

Parameters

text (str) – text