Developer documentation
Version 3.0.3-27-gb8de292c
Creating a new MRtrix command

The anatomy of a command

In MRtrix, each command corresponds to a source file (*.cpp), placed in the cmd/ folder, named identically to the desired application name (with the .cpp suffix). The file should contain the following sections:

First, the relevant headers should be included. This will include at least lib/command.h file, which includes the relevant code for executables.

#include "command.h"

Note that the lib/ folder is in the default search path. See Header search path for details.

At this point, it is helpful to bring the MR & MR::App namespaces within the current scope:

using namespace MR;
using namespace App;
Definition: base.h:24

Information about the application and its syntax is provided in the usage() function (described in more detail in this section):

void usage () {
void usage()

In this function, you can optionally set the author and copyright fields, which will be displayed when the command is invoked with the -version option. If ommitted, the author field will default to "J-Donald Tournier", and the copyright notice will default to that of the MRtrix core.

AUTHOR = "Joe Bloggs";
COPYRIGHT = "whatever you want";
const char * AUTHOR
set the author of the command
const char * COPYRIGHT
set the copyright notice if different from that used in MRtrix

The version information is obtained from the files lib/version.h (for the MRtrix core) and src/project_version.h (for external modules). Both of these are automatically updated to use the git version information if git installed - otherwise the information already contained in these files will be used as-is. If you want to set the version information for your module and can't use git, you can simply add the relevant information in the file src/project_version.h within your project, e.g.:

#define MRTRIX_PROJECT_VERSION "my-version-1.0"

You should then set a brief description of the command. Each entry corresponds to a new paragraph:

+ "This is used to illustrate how to write a command in MRtrix"
+ "This section is where you explain a bit more about your command, "
"its intended purpose, and any important pieces of information that "
" might not easily fit in the following sections";
additional description of the command over and above the synopsis

Next, you should specify the arguments required by the command (see thissection" for more details). The first entry for each argument is a brief name to appear on the syntax line. The second entry is longer description that will appear immediately after to explain what is expected in that argument. @code{cpp} ARGUMENTS + Argument ("input", "the input image." ).type_image_in() + Argument ("param", "the parameter controlling my algorithm." ).type_float(0.0, 1.0, 10.0) + Argument ("output", "the output image." ).type_image_out(); @endcode Note that the expected type (and potentially allowed range) of each argument can also be specified using the <tt>type_*()</tt> member functions. By default, each argument is a string. Also, an option can be specified to be optional, or that multiple such arguments are allowed. For more information, see the @ref command_line_arguments "command-line parsing documentation". Next, you can optionally specify any command-line options your command may accept. As for the MR::App::Argument class, the first entry for each option is a brief name, which in this case will be the name that the user will need to use on the command-line to invoke the option. The second entry is the description of the option. Optionally, each MR::App::Option can also have Arguments added to it. In this case, the description field of the Argument is ignored and should simply be ommitted. @code{cpp} OPTIONS + Option ("option1", "on option requiring two arguments") + Argument ("arg1").type_integer (0,1,10) + Argument ("arg2") + Option ("option2", "an option that does not take arguments"); } @endcode This marks the end of the usage() function. Actual processing will take place in the run() function. This function is declared <tt>void</tt>, and should not return any value. Any errors should be handled using C++ exceptions as described below. Note that any unhandled exception will cause the program to terminate with a non-zero return value. Arguments and options can be retrieved using the @ref MR::App::argument "argument" vector and @ref MR::App::get_options() "get_options()" function: @code{cpp} void run () { auto in = Image<float> (argument[0]); auto opt = get_options ("option1"); int arg1; std::string arg2; if (opt.size()) { arg1 = opt[0][0]; arg2 = opt[0][1]; } bool option2 = get_options ("option2").size(); // perform processing... } @endcode Note that the retrieved arguments are implicitly type-cast to the requested type, without any need for explicit conversion. It is also worth explaining that @ref MR::App::get_options() "get_options()" returns a vector of vectors of arguments. The first index returns the instance of the option (for cases where the same option can be specified multiple times), and the second index returns the argument supplied at that position for that instance of the option. For more information, see the @ref command_line_options "command-line parsing documentation". @section error_handling Error handling All error handling in MRtrix is done using C++ exceptions. MRtrix provides its own MR::Exception class, which additionally allows an error message to be displayed to the user. Developers are strongly encouraged to provide helpful error messages, so that users can work out what has gone wrong more easily. The following is an example of an exception in use: @code{cpp} void myfunc (float param) { if (isnan (param)) throw Exception ("NaN is not a valid parameter"); ... // do something useful ... } @endcode The strings helper functions can be used to provide more useful information: @code{cpp} void read_file (const std::string& filename, int64_t offset) { std::ifstream in (filename.c_str()); if (!in) throw Exception ("error opening file "" + filename + "": " + strerror (errno)); in.seekg (offset); if (!in.good()) throw Exception ("error seeking to offset " + str(offset) + " in file "" + filename + "": " + strerror (errno)); ... // do something useful ... } @endcode It is obviously possible to catch and handle these exceptions, as with any C++ exception: @code{cpp} try { read_file ("some_file.txt", 128); // no errors, return OK: return 0; } catch (Exception& E) { FAIL ("error in processing - message was:"); E.display(); return 1; } @endcode @note the error message of an Exception will only be shown if it left uncaught, or if it is explicitly displayed using its @ref MR::Exception::display() "display()" member function. @section include_path Header search path By default, the search path provided to the compiler to look for headers consists of the compiler's default path for system headers, any additional paths identified by the <tt>configure</tt> script as necessary to meet dependencies (e.g. Zlib or Eigen), and the <tt>lib/</tt> and <tt>src/</tt> folders. Headers should therefore be included by their path relative to one of these folders. For example, to include the file <tt>lib/math/SH.h</tt>, use the following: @code{cpp} #include "math/SH.h" @endcode Note that any MRtrix header must be supplied within quotes, as this signals to the <tt>build</tt> script that this header should be taken into account when generating the list of dependencies (see @ref build_section for details). Conversely, any system headers must be supplied within angled brackets, otherwise the <tt>build</tt> script will attempt (and fail) to locate it within the MRtrix include folders (usually <tt>lib/</tt> and <tt>src/</tt>) to work out its dependencies, etc. For example: @code{cpp} // These are system headers, and will not be taken // into account when working out dependencies: #include <iostream> #include <zlib.h> // These headers will be taken into account: // any changes to these headers (or any header they themselves // include) will cause the enclosing file to be recompiled // the next time the build script encounters them. #include "mrtrix.h" #include "math/SH.h"

Note that this is also good practice, since it is the convention for compilers to look within the system search path for headers included within angled brackets first, whereas headers included within quotes will be searched within the user search path first.