Skip to content.
CCB > CCBSIGS > ShapeToolLibraryProgram > RegularDiscreteDataTools > CreateDeformationGrid2DUserGuide

CreateDeformationGrid2D User Guide

Overview

This application creates a deformation grid from a regular discrete data (RDD) object. The grid is encoded as an OFF file, which can be viewed in the ShapeViewer. The grid will have the same coordinates and dimensions as the RDD object. The RDD object's data will be used to deform the coordinates of the vertices of the shape.

The RDD object can encode either the displacement or the destination coordinates of the warp. The user may specify which with a data handling mode command line flag. Additionally, the user may specify that the data values be ignored, in which case an unwarped grid is written. The coordinates of the shape vertices will be the coordinates of the samples of the RDD object. Only one data handling command line flag may be used at a time. See the usage page for the default mode.

Usage Page

Usage: java -jar CreateDeformationGrid2D.jar [options] -warp warpFilename.rdd -output outputShape.off

|   Argument   |  Type | REQ|              Description              |   Notes   |
|-overwrite    |flag   |No  |Enables file overwriting               |           |
|-debug        |flag   |No  |Enables additional error reporting     |           |
|-warp         |File   |Yes |This argument is used to specify the   |           |
|              |       |    |input warp. If this is not used, an    |           |
|              |       |    |unwarped grid is written.              |           |
|-output       |File   |Yes |This argument is used to specify the   |           |
|              |       |    |output filename                        |           |
|-disp         |flag   |No  |This argument specifies the data       |           |
|              |       |    |handling mode: Displacement Default:   |           |
|              |       |    |Displacement                           |           |
|-map          |flag   |No  |This argument specifies the data       |           |
|              |       |    |handling mode: Map Default:            |           |
|              |       |    |Displacement                           |           |
|-ident        |flag   |No  |This argument specifies the data       |           |
|              |       |    |handling mode: Identity Default:       |           |
|              |       |    |Displacement                           |           |
|-help         |flag   |No  |Prints help and usage information.     |           |
|-version      |flag   |No  |Prints version number of this          |           |
|              |       |    |application.                           |           |
|-verbose      |flag   |No  |Enables detailed status messages.      |           |
|-license      |flag   |No  |Prints license details, and exits.     |           |
|-twiki        |flag   |No  |Writes command line arguments as a     |           |
|              |       |    |TWiki format table to output and exit. |           |
|-pipeline     |flag   |No  |Write pipeline descriptor file to      |           |
|              |       |    |output and exit.                       |           |
|-pipelineJar  |String |No  |Specify path to an application jar     |Example:   |
|              |       |    |file, as a pipeline resource.          |"pipeline: |
|              |       |    |                                       |//localhos |
|              |       |    |                                       |t//home/ze |
|              |       |    |                                       |d/Connery. |
|              |       |    |                                       |jar"       |
|-pipelineJvm  |String |No  |Specify a Java Virtual Machine called  |           |
|              |       |    |by a pipeline.                         |           |
|-pipelineJvmOptions
|              |String |No  |Specify Java Virtual Machine options   |           |
|              |       |    |used by a pipeline.                    |           |


DESCRIPTION:

This creates a deformation grid for a given two dimensional warp.   
The data must be encoded to a regular discrete data object.   There 
are several ways of interpreting the data.   The regular discrete data 
object may encode the warp displacement at each sample, the 
destination coordinates of the warp.   The data values may be ignored, 
in which case the identity transformation is assumed, creating an 
unwarped grid.   There are command line argument flags for each of 
these options.   Only one of these flags may be used.   The output 
format is OFF.