Contents
- Introduction
- User Guide
- Tutorial
Usage
The basic usage is asl_file --data=<asldata> --ntis=<number_if_inflow_times> This specifies the ASl data source file and the number of inflow-times present in the data. Various options exits to specify the output required and, where needed, the structure of the data in the source and output files.
Input options
By default asl_file assumes that the input data is 'difference data', i.e. tag-control subtraction has already been performed. It is often useful to use asl_file with data in the form of tag-control pairs, this can be specified using the --iaf option.
--iaf=diff Input data is differenced, pairwise tag-control subtraction has already been performed.
--iaf=tc Input data is tag-control pairs, with the first volume being a tag (labelled) image.
--iaf=ct Input data is tag-control pairs, with the first volume being a control image.
Additionally where the data contains repeated volumes at different inflow times (multi inflow-time) it may be necessary to specify the 'block format', i.e. whether repeated measurements at the same inflow time are grouped together or appear grouped by repeat number.
--ibf=rpt Volumes with the same inflow times have been grouped together.
--inf=tis Volumes are grouped as repeated of the same set of inflow-times. This is most common, since it reflects a usual acquisition strategy to inter ate through the inflow times repeatedly.
Output Options
A filename for the output volume is specified by the --out=<filename> option. For multi inflow-time data the 'block format' for the output data can be specified (see above) using the --obf option, by default this matches the value of --ibf.
Pre-output Operations
A number of operations can be applied to the data prior to output (these cannot be combined).
--diff Do a pairwise subtraction of odd volumes from even volumes.
--spairs Split pairs within the data, i.e. split tag and control images. The output from each output option will create two (rather than one) files with _odd and _even appended to the name given to the output option. These contain the result of the output operation odd and even volumes respectively.
Output Operations
Apart from outputting the data subject to rearrangement of the internal structure using the output options or pre-output operations, further outputs can be generated after other operations have been performed.
--mean=<filename> Take the mean over the volumes, e.g. for the creation of the mean difference image from tag control pairs using the --diff option. For multi-delay data the mean is taken within each inflow-time, thus the final image will contain the same number of volumes as inflow-times specified by the --ti option.
--split=<filenameroot> For multi inflow-time data split the data into separate files for each inflow time.
--epoch=<filenameroot> Outputs as separate images the mean within individual epochs of the data.
- Parameters of the epochs are defined by
--elen=<value> The length of each epoch in the specified epoch units.
--eol=<value> The amount of overlap between epochs in the specified epoch units.
--eunit=<...> The units to be used for the creation of the epochs.
--eunit=rpt (default) Epochs are calculated with the unit of calculation being the number of repeats, this would always be appropriate for single inflow-time data. For multi inflow-time data the mean would be taken within each inflow-time in each epoch, thus each image would contain the same number of volumes as inflow-times specified by the --ti option.
--eunit=tis Specific to multi-inflow time data (and a very advanced option). This permits the creation of epochs from the raw time series such that each epoch will contain the specified number of volumes from the input data given by --elen, this could be a mixture of inflow-times (and repeats thereof) depending upon the ordering in the data.