freConstParameters.h

Go to the documentation of this file.

/*=========================================================================

  Program:   F.R.E.E. - flexible registration evaluation engine
  Version:   v.1.0.0
  Date:      $Date: 2006/09/01 12:00:00 $
  Module:    $RCSfile: freConstParameters.h,v $
  Language:  C++



  Copyright (c) 2007 Ralf o Floca (Department of Medical Informatics,
  Institute for Medical Biometry and Informatics, University of Heidelberg,
  Germany). All rights reserved.
  See FREECopyright.txt or http://www.mi.med.uni-hd.de/free/copyright.htm
  for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __freConstParameters_h
#define __freConstParameters_h

namespace FREE
{
//Macro for generation of a parameter ID and its description
#define DeclareParameterMacro( ParamID ) \
  static const char* const cParam_##ParamID;\
  static const char* const cParamDsc_##ParamID;\

#define DefineParameterMacro( Class, ParamID, sParam, sParamInfo ) \
  const char* const Class :: cParam_##ParamID = sParam; \
  const char* const Class :: cParamDsc_##ParamID = sParamInfo;

#define DefineParameterTemplateMacro( Class, Template, ParamID, sParam, sParamInfo ) \
        template < Template >\
        const char* const Class :: cParam_##ParamID = sParam; \
        template < Template >\
        const char* const Class :: cParamDsc_##ParamID = sParamInfo;

#define DeclareMediaIDMacro( MediaID ) \
  static const char* const MediaID_##MediaID;\
  static const char* const MediaIDDsc_##MediaID;\

#define DefineMediaIDMacro( Class, MediaID, sID, sMediaInfo ) \
  const char* const Class :: MediaID_##MediaID = sID; \
  const char* const Class :: MediaIDDsc_##MediaID = sMediaInfo;


//Macro for generation of a parameter ID and its description
#define ParameterMacro( ParamID, sParam, sParamInfo ) \
  const char* const cParam_##ParamID = sParam; \
  const char* const cParamDsc_##ParamID = sParamInfo

ParameterMacro(InitialTransformValues,"InitialTransformValues","Initial values of the transformation. Meaning depends on he transformation.");
ParameterMacro(CurrentTransformValues,"CurrentTransformValues","Curent values of the transformation. After registration, there are the final parameters. Directly before the registration the parameters used to initialize the transformation.");
ParameterMacro(TransformScale, "TransformScales", "Depending on the Transformation.");
ParameterMacro(MovingReferencePoints, "MovingReferencePoints","Reference points in the moving image. In special case lower levels are further points. Same layers in MovingReferencePoints and FixedReferencePoints are point couples.\n");
ParameterMacro(FixedReferencePoints, "FixedReferencePoints","Reference points in the fixed image. In special case lower levels are further points. Same layers in MovingReferencePoints and FixedReferencePoints are point couples.\n");
ParameterMacro(InitialisationMethod, "InitialisationMethod","Defines how the Transform will be initialized by initial transform values (itv) or estimation of the parameters. The kind of estimation depends on the transform and its setup.\n\n0: All initial parameters will be estimated");

ParameterMacro(ActualizeReferences, "ActualizeReferences","The section allows to actualize his references within the registration process, to avoid outdating of the setup be preceding transformations.\nThe actualizing will only have an effect, if the Registrator has activated ComputeTransformation.");
ParameterMacro(Iterations, "NrOfIterations","Maximums number of iterations the optimizer should do.");
ParameterMacro(StdDev, "StandardDeviation", "Standard deviation");
ParameterMacro(HistoMatch, "HistogramMatchOn","Use a histogram match on the moving image, when using same modality, to gain better results.");
ParameterMacro(HistoLevels, "HistogramLevels","Levels/Bins of the histogram.");
ParameterMacro(HistoMatchPoints, "HistogramPoints","Number of quantile values to be matched.");
ParameterMacro(HistoThreshold, "HistogramThresholdOn","Activates background exclusion for the histogram matching.");

ParameterMacro(SplinOrder, "SplineOrder","Order of the BSpline used. (0: almost nearest neighbor; 1: almost linear)");

ParameterMacro(MaxStepLength, "maxStepLength","Maximal size of the optimizer steps.");
ParameterMacro(MinStepLength, "minStepLength","Minimal size of the optimizer steps.");
ParameterMacro(GradMagTolerance, "GradMagTolerance","Tolerance of gradient magnitude.");
ParameterMacro(DynamicLevelStepLength, "DynamicLevelStepLength","Flag indicates if the last step length of the preceding level should be the max step length of the level.\n In the first level the maxStepLength value will always be used.");
ParameterMacro(LearningRate, "LearningRate","Learning Rate of the optimizer.");

ParameterMacro(Lambda, "Lambda","Adjust the capture radius of the metric.\nLow lambda means greater capture radius.");
ParameterMacro(ValueTolerance, "ValueTolerance","TODO");
ParameterMacro(EpsilonFunction, "EpsilonFunction","TODO");

ParameterMacro(ROIOrigin, "ROIOrigins","Origin of the ROI in the moving and fixed image (n is the dimension of the pipe).");
ParameterMacro(ROISize, "ROISize","Size of the ROI.");
ParameterMacro(ROIMaskFile, "MaskFile", "Specifies the path of the mask file to use with the ROI. If ROIType forces to use a mask and this value is empty, it will cause the registrator to make a callback.");
ParameterMacro(ROIMaskFileFeedback, "MaskFileFeedback", "Determines if the controller triggers an event before loading the mask file, so it can be checked and respecified.\n0: No event.\n1: Trigger event before loading mask.");

ParameterMacro(ROI_M_Origin, "ROIOrigins_Moving","Origin of the ROI in the moving and fixed image.");
ParameterMacro(ROI_M_Size, "ROISize_Moving","Size of the ROI for the moving Image of an image couple.");
ParameterMacro(ROI_M_MaskFile, "MaskFile_Moving", "Specifies the path of the mask file to use with the ROI. If ROIType forces to use a mask and this value is empty, it will cause the registrator to make a callback.");
ParameterMacro(ROI_M_MaskFileFeedback, "MaskFileFeedback_Moving", "Determines if the controller triggers an event before loading the mask file, so it can be checked and respecified.\n0: No event.\n1: Trigger event before loading mask.");

ParameterMacro(ROI_F_Origin, "ROIOrigins_Fixed","Origin of the ROI for the fixed image of an image couple.");
ParameterMacro(ROI_F_Size, "ROISize_Fixed","Size of the ROI for the moving Image of an image couple.");
ParameterMacro(ROI_F_MaskFile, "MaskFile_Fixed", "Specifies the path of the mask file to use with the ROI. If ROIType forces to use a mask and this value is empty, it will cause the registrator to make a callback.");
ParameterMacro(ROI_F_MaskFileFeedback, "MaskFileFeedback_Fixed", "Determines if the controller triggers an event before loading the mask file, so it can be checked and respecified.\n0: No event.\n1: Trigger event before loading mask.");

//Strings for the optimization strategy for the metric
ParameterMacro(MetricMinimize, "Minimize","Determines the the direction of the best metric value.\nThis Value is not meant to be configured by user, it stores predefined information. The registration process will always use the default value, even if changed in the setup file.");

ParameterMacro(FEMSetup, "SetupFile","File with the FEM setup information. (Full filename) If a setup file is given, all parameters for FEM are taken from the file, changing it in the fre-file has no effect.");
ParameterMacro(FEMRegLevels, "ResolutionLevels","Number of resolution levels for the registration.\n1 means single-res registration. In every level the resolution will be doubled, until the orginal resolution is reached.");
ParameterMacro(FEMPPE, "PixelsPerElement","Number of pixels per finite element.");
ParameterMacro(FEMElasticity, "Elasticity","Elasticity of the elemental connections");
ParameterMacro(FEMDensity, "Density","Density of the model");
ParameterMacro(FEMEnergyScale, "ImageEnergyScale","Image similarity energy weight (gamma) - sets gradient step size");
ParameterMacro(FEMNrIntPoints, "NrOfIntegrationPoints","This determines the number of integration points to use at each resolution. These integration points are used to generate the force.\nThe actual number used will be NrOfIntegrationPoints^d, where d is the number of parameters in the elements local domain.");
ParameterMacro(FEMWidthOfMetric, "WidthOfMetricRegion","The metric region allows one to compute the derivative (force) of the similarity metric using a region of size [i,i] in 2D [i,i,i] in 3D, where i is WidthOfMetricRegion.");
ParameterMacro(FEMAlpha, "Alpha","Set alpha for the trapezoidal rule.");
ParameterMacro(FEMDescentDirection, "DescentDirectionMinimize","FEM tries to maximize energy (1) or minimize it (0).");
ParameterMacro(FEMDoLineSearch, "DoLineSearch","LineSearch finds the minimum energy between the current and next solution by linear search.\n(0=never, 1=always, 2=if needed)");
ParameterMacro(FEMTimeStep, "TimeStep","Setting the time step.");
ParameterMacro(FEMEnergyReduction, "EnergyReduction","Sets the energy below which we decide the solution has converged.");
ParameterMacro(FEMLandmarkType, "LandmarkType","Defines if the fem should use landmarks and from which source.\n0: No Landmarks\n1: Use the file specified in the parameter LandmarkFile.\n2: Use the landmarks specified by the parameter Landmarks.");
ParameterMacro(FEMLandmarks, "Landmarks","Landmarks used for the fem. Every level is one couple of landmarks for the moving and fixed image.\n\n2D:\n1..2: x/y moving image\n3..4: x/y fixed image\n\n3D:\n1..3: x/y/z moving image\n4..6: x/y/z fixed image");
ParameterMacro(FEMLandmarkFile, "LandmarkFile","Uses a given landmark file for the registration.(Full filename with path)");
ParameterMacro(FEMMetric, "Metric","Metric type that should be used for the registration:\n0: Mean Square\n1: Normalized Correlation\n2: Pattern Intensity\n3: Mutual Information; StdDev = 0.4; Sample# = 0.5*( WidthOfMetric ^Image dimension)\n4: Mattes MI; bins = 10; Sample# = see 3.\n5: Demon based Metric");
ParameterMacro(FEMScaleGradient, "ScaleGradient","The scale gradient of the metric");
ParameterMacro(FEMRegridding, "EmployRegridding","Sets the use of multi-resolution strategy. 1 = true, 0 = false");

ParameterMacro(MRRegLevel, "ResolutionLevels","The level of the image pyramid.");
ParameterMacro(MRRegUseSchedule, "UseSchedule","If schedule is used, the pixel size for every level is get by the resolution schedule (ResolutionSchedule), otherwise the starting pixel size is 2^(levels-1) and will be halfed with every following level.");
ParameterMacro(MRRegResolutionSchedule, "ResolutionSchedule","The resolution schedule defines the pixel size in every dimension, for every level. The schedule will only be used, if UseSchedule is true.");

ParameterMacro(HistSize, "HistogramSize","Number of bins in the 2D histogram.\n1: bins for the fixed image\n2: bins for the moving image");
ParameterMacro(HistPadValue, "HistogramPaddingValue","Pixel value that should be ignored for histogram calculation.\n-1 (default) indicates to use every pixel value.");
ParameterMacro(HistDerivativeStep, "DerivativeStepLength","The 'length' of transform parameter changes to estimate the derivates for the actual parameter set.");
ParameterMacro(HistDerivativeScales, "DerivativeStepLengthScales","This value is similar to the scale value of transforms. It modifies the step length (length/scale) for every parameter in the process of derivates computation.\n If it is set to true the transform scales will be used, otherwise all parameters are treated equal.");
ParameterMacro(UpperBoundIncreaseFactor, "UpperBoundIncreaseFactor","");

} //end of namespace free
#endif

---