Param (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- bunwarpj.Param

```
public class Param
extends Object
```
This class stores the parameters to apply the consistent elastic registration and it is independent of the primary GUI.

Field Summary

Fields
Modifier and Type	Field and Description
`double`	`consistencyWeight` consistency weight
`double`	`curlWeight` curl weight
`double`	`divWeight` divergence weight
`double`	`imageWeight` image similarity weight
`int`	`img_subsamp_fact` image subsampling factor (from 0 to 7, representing 2^0=1 to 2^7 = 128)
`double`	`landmarkWeight` landmark weight
`int`	`max_scale_deformation` maximum scale deformation (0 - Very Coarse, 1 - Coarse, 2 - Fine, 3 - Very Fine, 4 - Super Fine)
`int`	`min_scale_deformation` minimum scale deformation (0 - Very Coarse, 1 - Coarse, 2 - Fine, 3 - Very Fine)
`int`	`mode` mode accuracy mode (0 - Fast, 1 - Accurate, 2 - Mono)
`protected String[]`	`sMaxScaleDeformationChoices` maximum scale deformation choices
`protected String[]`	`sMinScaleDeformationChoices` minimum scale deformation choices
`protected String[]`	`sRegistrationModes` available registration modes
`double`	`stopThreshold` stopping threshold

Constructor Summary

Constructors
Constructor and Description
`Param()` Empty constructor
`Param(int mode, int img_subsamp_fact, int min_scale_deformation, int max_scale_deformation, double divWeight, double curlWeight, double landmarkWeight, double imageWeight, double consistencyWeight, double stopThreshold)` Full constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getAnisotropyCorrection()`
`double`	`getScaleCorrection()`
`double`	`getShearCorrection()`
`void`	`setAnisotropyCorrection(double anisotropyCorrection)`
`void`	`setScaleCorrection(double scaleCorrection)`
`void`	`setShearCorrection(double shearCorrection)`
`boolean`	`showDialog()` Show modal dialog to collect bUnwarpJ parameters
`String`	`toString()` Print parameters into a String

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - mode
```
public int mode
```
    mode accuracy mode (0 - Fast, 1 - Accurate, 2 - Mono)
  - img_subsamp_fact
```
public int img_subsamp_fact
```
    image subsampling factor (from 0 to 7, representing 2^0=1 to 2^7 = 128)
  - min_scale_deformation
```
public int min_scale_deformation
```
    minimum scale deformation (0 - Very Coarse, 1 - Coarse, 2 - Fine, 3 - Very Fine)
  - max_scale_deformation
```
public int max_scale_deformation
```
    maximum scale deformation (0 - Very Coarse, 1 - Coarse, 2 - Fine, 3 - Very Fine, 4 - Super Fine)
  - divWeight
```
public double divWeight
```
    divergence weight
  - curlWeight
```
public double curlWeight
```
    curl weight
  - landmarkWeight
```
public double landmarkWeight
```
    landmark weight
  - imageWeight
```
public double imageWeight
```
    image similarity weight
  - consistencyWeight
```
public double consistencyWeight
```
    consistency weight
  - stopThreshold
```
public double stopThreshold
```
    stopping threshold
  - sRegistrationModes
```
protected final String[] sRegistrationModes
```
    available registration modes
  - sMinScaleDeformationChoices
```
protected final String[] sMinScaleDeformationChoices
```
    minimum scale deformation choices
  - sMaxScaleDeformationChoices
```
protected String[] sMaxScaleDeformationChoices
```
    maximum scale deformation choices
- Constructor Detail
  - Param
```
public Param()
```
    Empty constructor
  - Param
```
public Param(int mode,
             int img_subsamp_fact,
             int min_scale_deformation,
             int max_scale_deformation,
             double divWeight,
             double curlWeight,
             double landmarkWeight,
             double imageWeight,
             double consistencyWeight,
             double stopThreshold)
```
    Full constructor
    
    Parameters:
    
    mode - mode accuracy mode (0 - Fast, 1 - Accurate, 2 - Mono)
    
    img_subsamp_fact - image subsampling factor (from 0 to 7, representing 2^0=1 to 2^7 = 128)
    
    min_scale_deformation - minimum scale deformation (0 - Very Coarse, 1 - Coarse, 2 - Fine, 3 - Very Fine)
    
    max_scale_deformation - maximum scale deformation (0 - Very Coarse, 1 - Coarse, 2 - Fine, 3 - Very Fine, 4 - Super Fine)
    
    divWeight - divergence weight
    
    curlWeight - curl weight
    
    landmarkWeight - landmark weight
    
    imageWeight - image similarity weight
    
    consistencyWeight - consistency weight
    
    stopThreshold - stopping threshold
- Method Detail
  - showDialog
```
public boolean showDialog()
```
    Show modal dialog to collect bUnwarpJ parameters
    
    Returns:
    
    false if the dialog was canceled or true if it was not.
  - toString
```
public String toString()
```
    Print parameters into a String
    
    Overrides:
    
    toString in class Object
  - setShearCorrection
```
public void setShearCorrection(double shearCorrection)
```
  - getShearCorrection
```
public double getShearCorrection()
```
  - setScaleCorrection
```
public void setScaleCorrection(double scaleCorrection)
```
  - getScaleCorrection
```
public double getScaleCorrection()
```
  - setAnisotropyCorrection
```
public void setAnisotropyCorrection(double anisotropyCorrection)
```
  - getAnisotropyCorrection
```
public double getAnisotropyCorrection()
```

Class Param

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mode

img_subsamp_fact

min_scale_deformation

max_scale_deformation

divWeight

curlWeight

landmarkWeight

imageWeight

consistencyWeight

stopThreshold

sRegistrationModes

sMinScaleDeformationChoices

sMaxScaleDeformationChoices

Constructor Detail

Param

Param

Method Detail

showDialog

toString

setShearCorrection

getShearCorrection

setScaleCorrection

getScaleCorrection

setAnisotropyCorrection

getAnisotropyCorrection