Difference between revisions of "Ultracomm"
(Created page with "`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 a…") |
Keithjohnson (talk | contribs) |
||
| (17 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <code>ultracomm</code> is a command line utility for configuring Ultrasonix Tablet systems and acquiring ultrasound data. |
|
| − | In the |
+ | In the PhonLab we typically don't run <code>ultracomm</code> directly and instead run the [[ultrasession.py|<code>ultrasession.py</code>]] Python script, which handles a lot of bookkeeping details relevant to a data acquisition session automatically, and which calls <code>ultracomm</code> for you. |
| − | The |
+ | The <code>ultracomm</code> code and releases are available at [[https://github.com/rsprouse/ultracomm github]]. See the 'Releases' section for the latest released version. |
| + | |||
| + | == Usage == |
||
| + | |||
| + | <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 listing 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 all available options, use: |
||
| + | |||
| + | ultracomm --help |
||
| + | |||
| + | == A typical acquistion == |
||
| + | |||
| + | A typical acquisition with <code>ultracomm</code> proceeds by first initializing the ultrasound system and then acquiring data. The first call to <code>ultracomm</code> is non-interactive. It sets the ultrasound system to use the specified imaging parameters, then freezes the system to the non-imaging mode: |
||
| + | |||
| + | ultracomm --params /path/to/params.cfg --init-only |
||
| + | |||
| + | The second call to ultracomm starts acquiring data and saves to the output file specified by <code>--output</code>. |
||
| + | |||
| + | ultracomm --params /path/to/params.cfg --output /path/to/output.bpr |
||
| + | |||
| + | This command is interactive and prompts the user to press <code>Enter</code> to terminate the acquisition. <code>ultracomm</code> will confirm that the imaging parameters are correct before performing the acquisition. |
||
| + | |||
| + | The acquisition command can be repeated as many times as desired without re-executing the <code>--init-only</code> command. The imaging parameters will not change unless there is additional user interaction with the ultrasound system. |
||
Latest revision as of 10:01, 26 April 2018
ultracomm is a command line utility for configuring Ultrasonix Tablet systems and acquiring ultrasound data.
In the PhonLab we typically don't run ultracomm directly and instead run the ultrasession.py 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 listing of available parameters, see [params.cfg] in the ultracomm repository.
For all available options, use:
ultracomm --help
A typical acquistion
A typical acquisition with ultracomm proceeds by first initializing the ultrasound system and then acquiring data. The first call to ultracomm is non-interactive. It sets the ultrasound system to use the specified imaging parameters, then freezes the system to the non-imaging mode:
ultracomm --params /path/to/params.cfg --init-only
The second call to ultracomm starts acquiring data and saves to the output file specified by --output.
ultracomm --params /path/to/params.cfg --output /path/to/output.bpr
This command is interactive and prompts the user to press Enter to terminate the acquisition. ultracomm will confirm that the imaging parameters are correct before performing the acquisition.
The acquisition command can be repeated as many times as desired without re-executing the --init-only command. The imaging parameters will not change unless there is additional user interaction with the ultrasound system.
