...
- Create an empty text file. The standard file extension for piper files is
.piper
- Set a reader for your pipeline. To set values to parameters used by the reader class, simply add one or more
name=value
pairs after the class name.
* readFiles is a convenience command. "readFiles my/data
" is equivalent to "reader FileTreeReader InputDirectory=my/data
". - add annotation engines and cas consumers to your pipeline. To set values to parameters used by the annotation engine class, simply add one or more
name=value
pairs after the class name. - load common groups of components from another piper file. See Table 2 for piper files in cTAKES.
- reader, load and add* commands all take class names or file directories as their first parameter.
If the class is not in a standard cTAKES module's crae or cc package, or a piper file is not in a standard module's pipeline/ directory then the package or path must be specified for that component / file. - Use package to simplify adding multiple pipeline components from a package not standard to cTAKES.
Gliffy Diagram chrome min name Use of package - Use set to assign a value to a parameter used by following components.
Gliffy Diagram name set global value
*Aname=value
pair on a component line will, for that component, override a set parameter value. cli is a special type of set that sets a parameter to some value entered by the User on a command line.
Gliffy Diagram name Use of cli * cli can only be used with the
PiperFileRunner
class or thebin/runPiperFile
script.
* Reserved parameters unavailable for cli are listed in Table 3.addDescription is a special type of add that utilizes a component's static
addDescription(..)
method.* Use with care as not all components have such a method.
Use addLogged to ensure a component's start and finish time are logged. This is useful for debugging and profiling some components.
- Use addLast to ensure that a component, such as a writer, executes at the end of a pipeline. Multiple components can be added with addLast.
* writeXmis is a convenience command. "writeXmis my/output
" is equivalent to "add FileTreeXmiWriter OutputDirectory=my/output
". name=value
pairs can accept comma-delimited arrays:ArrayParm=this,is,an,array
* Texts enclosed in quotes are not arrays:NotArrayParm="this,is,just,text"
- To run a piper file from the command line, execute the script
bin/runPiperFile -p path/to/piper
To run a piper from code use the
main(..)
method ofPiperFileRunner
in ctakes-core, or more directly use thePiperFileReader
class in ctakes-core.There are examples of piper file use in the ctakes-examples module.
- A piper file can also be loaded and run by the Simple Pipeline Fabricator GUI.
...