Difference between revisions of "Ultracomm"
m |
m (→Usage) |
||
| Line 7: | Line 7: | ||
== Usage == |
== Usage == |
||
| − | <code>ultracomm</code> accepts a number of parameters that are used to connect to and configure the Ultrasonix system. |
+ | <code>ultracomm</code> accepts a number of parameters that are used to connect to and configure the Ultrasonix system. These parameters can be included on the command line or aggregated in a parameter file that is included with the <code>--params</code> option. |
| + | |||
| + | ultracomm --params /path/to/params.cfg |
||
| + | |||
| + | The <code>--address</code> and <code>--output</code> parameters are required unless an information-only option was invoked (e.g. <code>--help</code> or <code>--version</code>). <code>--address</code> specifies the IP address of the Ultrasonix system, and <code>--output</code> names an output file containing a series of ultrasound images. |
||
For a sample of available parameters, see [[https://github.com/rsprouse/ultracomm/blob/master/resources/params.cfg <code>params.cfg</code>]] in the <code>ultracomm</code> repository. |
For a sample of available parameters, see [[https://github.com/rsprouse/ultracomm/blob/master/resources/params.cfg <code>params.cfg</code>]] in the <code>ultracomm</code> repository. |
||
Revision as of 12:49, 18 August 2015
ultracomm is a command line utility for configuring Ultrasonix Tablet systems and acquiring ultrasound data.
In the Phonology Lab we typically don't run ultracomm directly and instead run the ultrasession Python script, which handles a lot of bookkeeping details relevant to a data acquisition session automatically, and which calls ultracomm for you.
The ultracomm code and releases are available at [github]. See the 'Releases' section for the latest released version.
Usage
ultracomm accepts a number of parameters that are used to connect to and configure the Ultrasonix system. These parameters can be included on the command line or aggregated in a parameter file that is included with the --params option.
ultracomm --params /path/to/params.cfg
The --address and --output parameters are required unless an information-only option was invoked (e.g. --help or --version). --address specifies the IP address of the Ultrasonix system, and --output names an output file containing a series of ultrasound images.
For a sample of available parameters, see [params.cfg] in the ultracomm repository.
For all available options, try:
ultracomm --help
