freConstParameters.h File Reference

This graph shows which files directly or indirectly include this file:

freConstantValues.hfreConstParameters.cxxfreElementals.hfreConvert.cxxfreLogFileController.hfreConstantValues.cxxfreCollectionBase.hfreExceptions.hfreXMLValueSet.hfreConvertValueSet.hfreXMLCollectionBase.hfreLightRegistrationProcessorBase.hfreTransformInitializer.hfreSetupOptimizationProcessor.hfreVectorFieldSetVarianceCalculator.hfreControllerBase.hfreEvolutionaryStrategyCtrlrs.hfreImageFilterCtrlrs.hfreITKFilterCtrlrs.hfreMediaCtrlrs.hfrePointSupportedMetricCtrlrs.hfreInterpolatorCtrlrs.hfreMetricCtrlrs.hfreRegistrationCtrlrs.hfreTransformationCtrlrs.hfreSetupOptimizationCtrlrs.hfreControllerInterface.hfreConvert.hfreXMLStreamObject.hfreEvents.hfreRegistrationObserver.hfreImageIO.hfreROI.hfreImageTypes.hfreLogFileController.cxxfrePointerSentry.hfreSetupOptimizationMetric.hfreSetupOptimizationObserverEvents.hfreSetupOptimizationProgressObserver.hfreConstrainedSetupTransform.hfreSetupTransform.hfreSetupParameterTraits.hfreSetupParameterTraitsGenerator.hfreSetupParameterConstraints.hfreSetupParameterConstraint.hfreGenericSetupToImageAdaptor.hfreImageAdaptationInverter.hfreImageMerger.hfreSetupInterpolator.h

Go to the source code of this file.

Namespaces

namespace  FREE

Defines

#define DeclareParameterMacro(ParamID)
#define DefineParameterMacro(Class, ParamID, sParam, sParamInfo)
#define DefineParameterTemplateMacro(Class, Template, ParamID, sParam, sParamInfo)
#define DeclareMediaIDMacro(MediaID)
#define DefineMediaIDMacro(Class, MediaID, sID, sMediaInfo)
#define ParameterMacro(ParamID, sParam, sParamInfo)

Variables

const char *const FREE::cParam_InitialTransformValues = "InitialTransformValues"
const char *const FREE::cParamDsc_InitialTransformValues = "Initial values of the transformation. Meaning depends on he transformation."
const char *const FREE::cParam_CurrentTransformValues = "CurrentTransformValues"
const char *const FREE::cParamDsc_CurrentTransformValues = "Curent values of the transformation. After registration, there are the final parameters. Directly before the registration the parameters used to initialize the transformation."
const char *const FREE::cParam_TransformScale = "TransformScales"
const char *const FREE::cParamDsc_TransformScale = "Depending on the Transformation."
const char *const FREE::cParam_MovingReferencePoints = "MovingReferencePoints"
const char *const FREE::cParamDsc_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"
const char *const FREE::cParam_FixedReferencePoints = "FixedReferencePoints"
const char *const FREE::cParamDsc_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"
const char *const FREE::cParam_InitialisationMethod = "InitialisationMethod"
const char *const FREE::cParamDsc_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"
const char *const FREE::cParam_ActualizeReferences = "ActualizeReferences"
const char *const FREE::cParamDsc_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."
const char *const FREE::cParam_Iterations = "NrOfIterations"
const char *const FREE::cParamDsc_Iterations = "Maximums number of iterations the optimizer should do."
const char *const FREE::cParam_StdDev = "StandardDeviation"
const char *const FREE::cParamDsc_StdDev = "Standard deviation"
const char *const FREE::cParam_HistoMatch = "HistogramMatchOn"
const char *const FREE::cParamDsc_HistoMatch = "Use a histogram match on the moving image, when using same modality, to gain better results."
const char *const FREE::cParam_HistoLevels = "HistogramLevels"
const char *const FREE::cParamDsc_HistoLevels = "Levels/Bins of the histogram."
const char *const FREE::cParam_HistoMatchPoints = "HistogramPoints"
const char *const FREE::cParamDsc_HistoMatchPoints = "Number of quantile values to be matched."
const char *const FREE::cParam_HistoThreshold = "HistogramThresholdOn"
const char *const FREE::cParamDsc_HistoThreshold = "Activates background exclusion for the histogram matching."
const char *const FREE::cParam_SplinOrder = "SplineOrder"
const char *const FREE::cParamDsc_SplinOrder = "Order of the BSpline used. (0: almost nearest neighbor; 1: almost linear)"
const char *const FREE::cParam_MaxStepLength = "maxStepLength"
const char *const FREE::cParamDsc_MaxStepLength = "Maximal size of the optimizer steps."
const char *const FREE::cParam_MinStepLength = "minStepLength"
const char *const FREE::cParamDsc_MinStepLength = "Minimal size of the optimizer steps."
const char *const FREE::cParam_GradMagTolerance = "GradMagTolerance"
const char *const FREE::cParamDsc_GradMagTolerance = "Tolerance of gradient magnitude."
const char *const FREE::cParam_DynamicLevelStepLength = "DynamicLevelStepLength"
const char *const FREE::cParamDsc_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."
const char *const FREE::cParam_LearningRate = "LearningRate"
const char *const FREE::cParamDsc_LearningRate = "Learning Rate of the optimizer."
const char *const FREE::cParam_Lambda = "Lambda"
const char *const FREE::cParamDsc_Lambda = "Adjust the capture radius of the metric.\nLow lambda means greater capture radius."
const char *const FREE::cParam_ValueTolerance = "ValueTolerance"
const char *const FREE::cParamDsc_ValueTolerance = "TODO"
const char *const FREE::cParam_EpsilonFunction = "EpsilonFunction"
const char *const FREE::cParamDsc_EpsilonFunction = "TODO"
const char *const FREE::cParam_ROIOrigin = "ROIOrigins"
const char *const FREE::cParamDsc_ROIOrigin = "Origin of the ROI in the moving and fixed image (n is the dimension of the pipe)."
const char *const FREE::cParam_ROISize = "ROISize"
const char *const FREE::cParamDsc_ROISize = "Size of the ROI."
const char *const FREE::cParam_ROIMaskFile = "MaskFile"
const char *const FREE::cParamDsc_ROIMaskFile = "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."
const char *const FREE::cParam_ROIMaskFileFeedback = "MaskFileFeedback"
const char *const FREE::cParamDsc_ROIMaskFileFeedback = "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."
const char *const FREE::cParam_ROI_M_Origin = "ROIOrigins_Moving"
const char *const FREE::cParamDsc_ROI_M_Origin = "Origin of the ROI in the moving and fixed image."
const char *const FREE::cParam_ROI_M_Size = "ROISize_Moving"
const char *const FREE::cParamDsc_ROI_M_Size = "Size of the ROI for the moving Image of an image couple."
const char *const FREE::cParam_ROI_M_MaskFile = "MaskFile_Moving"
const char *const FREE::cParamDsc_ROI_M_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."
const char *const FREE::cParam_ROI_M_MaskFileFeedback = "MaskFileFeedback_Moving"
const char *const FREE::cParamDsc_ROI_M_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."
const char *const FREE::cParam_ROI_F_Origin = "ROIOrigins_Fixed"
const char *const FREE::cParamDsc_ROI_F_Origin = "Origin of the ROI for the fixed image of an image couple."
const char *const FREE::cParam_ROI_F_Size = "ROISize_Fixed"
const char *const FREE::cParamDsc_ROI_F_Size = "Size of the ROI for the moving Image of an image couple."
const char *const FREE::cParam_ROI_F_MaskFile = "MaskFile_Fixed"
const char *const FREE::cParamDsc_ROI_F_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."
const char *const FREE::cParam_ROI_F_MaskFileFeedback = "MaskFileFeedback_Fixed"
const char *const FREE::cParamDsc_ROI_F_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."
const char *const FREE::cParam_MetricMinimize = "Minimize"
const char *const FREE::cParamDsc_MetricMinimize = "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."
const char *const FREE::cParam_FEMSetup = "SetupFile"
const char *const FREE::cParamDsc_FEMSetup = "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."
const char *const FREE::cParam_FEMRegLevels = "ResolutionLevels"
const char *const FREE::cParamDsc_FEMRegLevels = "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."
const char *const FREE::cParam_FEMPPE = "PixelsPerElement"
const char *const FREE::cParamDsc_FEMPPE = "Number of pixels per finite element."
const char *const FREE::cParam_FEMElasticity = "Elasticity"
const char *const FREE::cParamDsc_FEMElasticity = "Elasticity of the elemental connections"
const char *const FREE::cParam_FEMDensity = "Density"
const char *const FREE::cParamDsc_FEMDensity = "Density of the model"
const char *const FREE::cParam_FEMEnergyScale = "ImageEnergyScale"
const char *const FREE::cParamDsc_FEMEnergyScale = "Image similarity energy weight (gamma) - sets gradient step size"
const char *const FREE::cParam_FEMNrIntPoints = "NrOfIntegrationPoints"
const char *const FREE::cParamDsc_FEMNrIntPoints = "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."
const char *const FREE::cParam_FEMWidthOfMetric = "WidthOfMetricRegion"
const char *const FREE::cParamDsc_FEMWidthOfMetric = "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."
const char *const FREE::cParam_FEMAlpha = "Alpha"
const char *const FREE::cParamDsc_FEMAlpha = "Set alpha for the trapezoidal rule."
const char *const FREE::cParam_FEMDescentDirection = "DescentDirectionMinimize"
const char *const FREE::cParamDsc_FEMDescentDirection = "FEM tries to maximize energy (1) or minimize it (0)."
const char *const FREE::cParam_FEMDoLineSearch = "DoLineSearch"
const char *const FREE::cParamDsc_FEMDoLineSearch = "LineSearch finds the minimum energy between the current and next solution by linear search.\n(0=never, 1=always, 2=if needed)"
const char *const FREE::cParam_FEMTimeStep = "TimeStep"
const char *const FREE::cParamDsc_FEMTimeStep = "Setting the time step."
const char *const FREE::cParam_FEMEnergyReduction = "EnergyReduction"
const char *const FREE::cParamDsc_FEMEnergyReduction = "Sets the energy below which we decide the solution has converged."
const char *const FREE::cParam_FEMLandmarkType = "LandmarkType"
const char *const FREE::cParamDsc_FEMLandmarkType = "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."
const char *const FREE::cParam_FEMLandmarks = "Landmarks"
const char *const FREE::cParamDsc_FEMLandmarks = "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"
const char *const FREE::cParam_FEMLandmarkFile = "LandmarkFile"
const char *const FREE::cParamDsc_FEMLandmarkFile = "Uses a given landmark file for the registration.(Full filename with path)"
const char *const FREE::cParam_FEMMetric = "Metric"
const char *const FREE::cParamDsc_FEMMetric = "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"
const char *const FREE::cParam_FEMScaleGradient = "ScaleGradient"
const char *const FREE::cParamDsc_FEMScaleGradient = "The scale gradient of the metric"
const char *const FREE::cParam_FEMRegridding = "EmployRegridding"
const char *const FREE::cParamDsc_FEMRegridding = "Sets the use of multi-resolution strategy. 1 = true, 0 = false"
const char *const FREE::cParam_MRRegLevel = "ResolutionLevels"
const char *const FREE::cParamDsc_MRRegLevel = "The level of the image pyramid."
const char *const FREE::cParam_MRRegUseSchedule = "UseSchedule"
const char *const FREE::cParamDsc_MRRegUseSchedule = "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."
const char *const FREE::cParam_MRRegResolutionSchedule = "ResolutionSchedule"
const char *const FREE::cParamDsc_MRRegResolutionSchedule = "The resolution schedule defines the pixel size in every dimension, for every level. The schedule will only be used, if UseSchedule is true."
const char *const FREE::cParam_HistSize = "HistogramSize"
const char *const FREE::cParamDsc_HistSize = "Number of bins in the 2D histogram.\n1: bins for the fixed image\n2: bins for the moving image"
const char *const FREE::cParam_HistPadValue = "HistogramPaddingValue"
const char *const FREE::cParamDsc_HistPadValue = "Pixel value that should be ignored for histogram calculation.\n-1 (default) indicates to use every pixel value."
const char *const FREE::cParam_HistDerivativeStep = "DerivativeStepLength"
const char *const FREE::cParamDsc_HistDerivativeStep = "The 'length' of transform parameter changes to estimate the derivates for the actual parameter set."
const char *const FREE::cParam_HistDerivativeScales = "DerivativeStepLengthScales"
const char *const FREE::cParamDsc_HistDerivativeScales = "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."
const char *const FREE::cParam_UpperBoundIncreaseFactor = "UpperBoundIncreaseFactor"
const char *const FREE::cParamDsc_UpperBoundIncreaseFactor = ""


Define Documentation

#define DeclareMediaIDMacro ( MediaID   ) 

Value:

static const char* const MediaID_##MediaID;\
  static const char* const MediaIDDsc_##MediaID;\

Definition at line 42 of file freConstParameters.h.

#define DeclareParameterMacro ( ParamID   ) 

Value:

static const char* const cParam_##ParamID;\
  static const char* const cParamDsc_##ParamID;\

Definition at line 28 of file freConstParameters.h.

Referenced by FREE::freControllerIDMacro().

#define DefineMediaIDMacro ( Class,
MediaID,
sID,
sMediaInfo   ) 

Value:

const char* const Class :: MediaID_##MediaID = sID; \
  const char* const Class :: MediaIDDsc_##MediaID = sMediaInfo;

Definition at line 46 of file freConstParameters.h.

#define DefineParameterMacro ( Class,
ParamID,
sParam,
sParamInfo   ) 

Value:

const char* const Class :: cParam_##ParamID = sParam; \
  const char* const Class :: cParamDsc_##ParamID = sParamInfo;

Definition at line 32 of file freConstParameters.h.

#define DefineParameterTemplateMacro ( Class,
Template,
ParamID,
sParam,
sParamInfo   ) 

Value:

template < Template >\
        const char* const Class :: cParam_##ParamID = sParam; \
        template < Template >\
        const char* const Class :: cParamDsc_##ParamID = sParamInfo;

Definition at line 36 of file freConstParameters.h.

#define ParameterMacro ( ParamID,
sParam,
sParamInfo   ) 

Value:

const char* const cParam_##ParamID = sParam; \
  const char* const cParamDsc_##ParamID = sParamInfo

Definition at line 52 of file freConstParameters.h.


Generated at Sat Oct 13 18:14:22 2007 for f.r.e.e. - Flexible Registration and Evaluation Engine by doxygen 1.5.3 written by Dimitri van Heesch, © 1997-2000