Registration configuration file

The registration configuration file can be used to control or skip some of the steps in the registration process. It consists of a header section and then a series of per-bone sections.

The header section begins with a line reading [main] and contains a startBone declaration. The declarations following define default values for all the bones in the scan. The pound character # indicates a comment.

[main]
startBone=rad
decentFitValue=10                                                                   
failFitValue=20                                                                     
TranslationLimit=5                                                                  
RotationLimit=0.5                                                                   
...
[tpd]
dependsOn=tpm
runMode=fixed
StartTranslation=-0.35307  0.28524  -0.301178
StartRotation=0.0150448  -0.0528962  -0.000270465

The fields have the following meaning. All the bone names are the three-letter short versions.

startBone: The first bone in the hierarchy. Almost always the radius. dependsOn: Required for each bone except the startBone. Indicates the bone above this one in the bone hierarchy. decentFitValue: A fit value less than this number counts as success. The optimization does not use this value as a test; it only seeks to minimize the fit value. This setting simply issues a warning when it is exceeded. failFitValue: If the final fit value is greater than this number, it will trigger an error and several warning messages. The system will try to repeat the optimization with an increased RotationLimit before it fails. TranslationLimit: In the optimization step, translations are limited to this distance in any direction. RotationLimit: In the optimization step, rotations are limited to the range (-pi * RotationLimit, pi * RotationLimit). runMode: 'fixed' or 'twice'. For 'fixed' mode, the optimization step is skipped and the values given by StartTranslation and StartRotation are returned. 'twice' is not implemented and should not be used. If you don't want fixed mode, omit this parameter. StartTranslation: When runMode is 'fixed' this is the final translation value, three coordinates separated by spaces. When not in fixed run mode, this value is sent to the optimization step as an initial guess. StartRotation: When runMode is 'fixed' this is the final rotation value, three coordinates separated by spaces, to be multiplied by pi before being used. When not in fixed run mode, this value is sent to the optimization step as an initial guess.

After a registration run, you will find sample registration configuration files in the $DATA/warmBones directory. These can be used in conjunction with the --warmConfig option to skip the registration calculation for bones whose position has already been found. Use this to recover from an error without having to re-run all the bones before the one that caused the failure.