itk::fem::ImageMetricLoad< TMoving, TFixed > Class Template Reference
General image pair load that uses the itkImageToImageMetrics. More...
#include <itkFEMImageMetricLoad.h>
Detailed Description
template<class TMoving, class TFixed>
class itk::fem::ImageMetricLoad< TMoving, TFixed >
General image pair load that uses the itkImageToImageMetrics.
LoadImageMetric computes FEM gravity loads by using derivatives provided by itkImageToImageMetrics (e.g. mean squares intensity difference.) The function responsible for this is called Fg, as required by the FEMLoad standards. It takes a vnl_vector as input. We assume the vector input is of size 2*ImageDimension. The 0 to ImageDimension-1 elements contain the position, p, in the reference (moving) image. The next ImageDimension to 2*ImageDimension-1 elements contain the value of the vector field at that point, v(p).
Then, we evaluate the derivative at the point p+v(p) with respect to some region of the target (fixed) image by calling the metric with the translation parameters as provided by the vector field at p. The metrics return both a scalar similarity value and vector-valued derivative. The derivative is what gives us the force to drive the FEM registration. These values are computed with respect to some region in the Fixed image. This region size may be set by the user by calling SetMetricRadius. As the metric derivative computation evolves, performance should improve and more functionality will be available (such as scale selection).
Definition at line 70 of file itkFEMImageMetricLoad.h.
Member Typedef Documentation
typedef FEMPArray<Self> itk::fem::Load::ArrayType [inherited] |
Array class that holds special pointers to the load objects
Definition at line 42 of file itkFEMLoadBase.h.
typedef Self itk::fem::FEMLightObject::Baseclass [inherited] |
Store the base class typedef for easy access from derived classes. FEM_CLASS macro also expects this for the FEMOF...
Definition at line 64 of file itkFEMLightObject.h.
| typedef Float itk::fem::ImageMetricLoad< TMoving, TFixed >::ComputationType |
Definition at line 111 of file itkFEMImageMetricLoad.h.
| typedef const Self* itk::fem::ImageMetricLoad< TMoving, TFixed >::ConstPointer |
Const pointer or SmartPointer to an object.
Reimplemented from itk::fem::LoadElement.
Definition at line 72 of file itkFEMImageMetricLoad.h.
| typedef double itk::fem::ImageMetricLoad< TMoving, TFixed >::CoordinateRepresentationType |
Definition at line 122 of file itkFEMImageMetricLoad.h.
| typedef MeanSquaresMetricType itk::fem::ImageMetricLoad< TMoving, TFixed >::DefaultMetricType |
Definition at line 136 of file itkFEMImageMetricLoad.h.
| typedef TranslationTransform<CoordinateRepresentationType, itkGetStaticConstMacro(ImageDimension) > itk::fem::ImageMetricLoad< TMoving, TFixed >::DefaultTransformType |
Definition at line 124 of file itkFEMImageMetricLoad.h.
typedef std::vector<Element::ConstPointer> itk::fem::LoadElement::ElementPointersVectorType [inherited] |
Type of array of pointers to element objects
Definition at line 54 of file itkFEMLoadElementBase.h.
| typedef FixedType::ConstPointer itk::fem::ImageMetricLoad< TMoving, TFixed >::FixedConstPointer |
Definition at line 83 of file itkFEMImageMetricLoad.h.
| typedef FixedNeighborhoodIteratorType::IndexType itk::fem::ImageMetricLoad< TMoving, TFixed >::FixedNeighborhoodIndexType |
Definition at line 102 of file itkFEMImageMetricLoad.h.
| typedef NeighborhoodIterator<FixedType> itk::fem::ImageMetricLoad< TMoving, TFixed >::FixedNeighborhoodIteratorType |
Definition at line 100 of file itkFEMImageMetricLoad.h.
| typedef FixedType* itk::fem::ImageMetricLoad< TMoving, TFixed >::FixedPointer |
Definition at line 82 of file itkFEMImageMetricLoad.h.
| typedef FixedNeighborhoodIteratorType::RadiusType itk::fem::ImageMetricLoad< TMoving, TFixed >::FixedRadiusType |
Definition at line 104 of file itkFEMImageMetricLoad.h.
| typedef TFixed itk::fem::ImageMetricLoad< TMoving, TFixed >::FixedType |
Definition at line 81 of file itkFEMImageMetricLoad.h.
| typedef LoadElement::Float itk::fem::ImageMetricLoad< TMoving, TFixed >::Float |
Float type used in Element and derived classes
Reimplemented from itk::fem::LoadElement.
Definition at line 76 of file itkFEMImageMetricLoad.h.
| typedef GradientRecursiveGaussianImageFilter< ImageType, GradientImageType > itk::fem::ImageMetricLoad< TMoving, TFixed >::GradientImageFilterType |
Gradient filtering
Definition at line 155 of file itkFEMImageMetricLoad.h.
| typedef SmartPointer<GradientImageType> itk::fem::ImageMetricLoad< TMoving, TFixed >::GradientImagePointer |
Gradient filtering
Definition at line 152 of file itkFEMImageMetricLoad.h.
| typedef Image<GradientPixelType, itkGetStaticConstMacro(ImageDimension)> itk::fem::ImageMetricLoad< TMoving, TFixed >::GradientImageType |
Gradient filtering
Definition at line 151 of file itkFEMImageMetricLoad.h.
| typedef CovariantVector<RealType, itkGetStaticConstMacro(ImageDimension)> itk::fem::ImageMetricLoad< TMoving, TFixed >::GradientPixelType |
Gradient filtering
Definition at line 149 of file itkFEMImageMetricLoad.h.
| typedef Image< PixelType, itkGetStaticConstMacro(ImageDimension) > itk::fem::ImageMetricLoad< TMoving, TFixed >::ImageType |
Definition at line 114 of file itkFEMImageMetricLoad.h.
| typedef LinearInterpolateImageFunction< MovingType, double > itk::fem::ImageMetricLoad< TMoving, TFixed >::InterpolatorType |
Definition at line 144 of file itkFEMImageMetricLoad.h.
| typedef DefaultTransformType::JacobianType itk::fem::ImageMetricLoad< TMoving, TFixed >::JacobianType |
Definition at line 138 of file itkFEMImageMetricLoad.h.
| typedef MeanSquaresImageToImageMetric< MovingType, FixedType > itk::fem::ImageMetricLoad< TMoving, TFixed >::MeanSquaresMetricType |
Definition at line 132 of file itkFEMImageMetricLoad.h.
| typedef ImageToImageMetric<FixedType,MovingType > itk::fem::ImageMetricLoad< TMoving, TFixed >::MetricBaseType |
Type of supported metrics.
Definition at line 127 of file itkFEMImageMetricLoad.h.
| typedef MetricBaseType::Pointer itk::fem::ImageMetricLoad< TMoving, TFixed >::MetricBaseTypePointer |
Definition at line 128 of file itkFEMImageMetricLoad.h.
| typedef MovingType::ConstPointer itk::fem::ImageMetricLoad< TMoving, TFixed >::MovingConstPointer |
Definition at line 79 of file itkFEMImageMetricLoad.h.
| typedef MovingNeighborhoodIteratorType::IndexType itk::fem::ImageMetricLoad< TMoving, TFixed >::MovingNeighborhoodIndexType |
Definition at line 96 of file itkFEMImageMetricLoad.h.
| typedef NeighborhoodIterator<MovingType> itk::fem::ImageMetricLoad< TMoving, TFixed >::MovingNeighborhoodIteratorType |
Definition at line 94 of file itkFEMImageMetricLoad.h.
| typedef MovingType* itk::fem::ImageMetricLoad< TMoving, TFixed >::MovingPointer |
Definition at line 80 of file itkFEMImageMetricLoad.h.
| typedef MovingNeighborhoodIteratorType::RadiusType itk::fem::ImageMetricLoad< TMoving, TFixed >::MovingRadiusType |
Definition at line 98 of file itkFEMImageMetricLoad.h.
| typedef TMoving itk::fem::ImageMetricLoad< TMoving, TFixed >::MovingType |
Definition at line 78 of file itkFEMImageMetricLoad.h.
| typedef MutualInformationImageToImageMetric< MovingType, FixedType > itk::fem::ImageMetricLoad< TMoving, TFixed >::MutualInformationMetricType |
Definition at line 130 of file itkFEMImageMetricLoad.h.
| typedef NormalizedCorrelationImageToImageMetric< MovingType, FixedType > itk::fem::ImageMetricLoad< TMoving, TFixed >::NormalizedCorrelationMetricType |
Definition at line 134 of file itkFEMImageMetricLoad.h.
| typedef DefaultTransformType::ParametersType itk::fem::ImageMetricLoad< TMoving, TFixed >::ParametersType |
Definition at line 137 of file itkFEMImageMetricLoad.h.
| typedef Float itk::fem::ImageMetricLoad< TMoving, TFixed >::PixelType |
Definition at line 110 of file itkFEMImageMetricLoad.h.
| typedef Self* itk::fem::ImageMetricLoad< TMoving, TFixed >::Pointer |
Pointer or SmartPointer to an object.
Reimplemented from itk::fem::LoadElement.
Definition at line 72 of file itkFEMImageMetricLoad.h.
| typedef float itk::fem::ImageMetricLoad< TMoving, TFixed >::RealType |
Gradient filtering
Definition at line 147 of file itkFEMImageMetricLoad.h.
| typedef Image< RefPixelType, itkGetStaticConstMacro(ImageDimension) > itk::fem::ImageMetricLoad< TMoving, TFixed >::RefImageType |
Definition at line 112 of file itkFEMImageMetricLoad.h.
| typedef MovingType::PixelType itk::fem::ImageMetricLoad< TMoving, TFixed >::RefPixelType |
Definition at line 108 of file itkFEMImageMetricLoad.h.
| typedef ImageRegionIteratorWithIndex<MovingType> itk::fem::ImageMetricLoad< TMoving, TFixed >::RefRegionIteratorType |
Definition at line 89 of file itkFEMImageMetricLoad.h.
| typedef ImageMetricLoad itk::fem::ImageMetricLoad< TMoving, TFixed >::Self |
Standard Self typedef.
Reimplemented from itk::fem::LoadElement.
Definition at line 72 of file itkFEMImageMetricLoad.h.
| typedef LoadElement itk::fem::ImageMetricLoad< TMoving, TFixed >::Superclass |
Standard Superclass typedef.
Reimplemented from itk::fem::LoadElement.
Definition at line 72 of file itkFEMImageMetricLoad.h.
| typedef Image< TarPixelType, itkGetStaticConstMacro(ImageDimension) > itk::fem::ImageMetricLoad< TMoving, TFixed >::TarImageType |
Definition at line 113 of file itkFEMImageMetricLoad.h.
| typedef FixedType::PixelType itk::fem::ImageMetricLoad< TMoving, TFixed >::TarPixelType |
Definition at line 109 of file itkFEMImageMetricLoad.h.
| typedef ImageRegionIteratorWithIndex<FixedType> itk::fem::ImageMetricLoad< TMoving, TFixed >::TarRegionIteratorType |
Definition at line 90 of file itkFEMImageMetricLoad.h.
| typedef Transform< CoordinateRepresentationType,itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) > itk::fem::ImageMetricLoad< TMoving, TFixed >::TransformBaseType |
Definition at line 123 of file itkFEMImageMetricLoad.h.
| typedef vnl_vector<Float> itk::fem::ImageMetricLoad< TMoving, TFixed >::VectorType |
Definition at line 115 of file itkFEMImageMetricLoad.h.
Constructor & Destructor Documentation
| itk::fem::ImageMetricLoad< TMoving, TFixed >::ImageMetricLoad | ( | ) |
Member Function Documentation
| virtual int itk::fem::ImageMetricLoad< TMoving, TFixed >::ClassID | ( | ) | const [inline, virtual] |
Virtual function to access the class ID
Reimplemented from itk::fem::LoadElement.
Definition at line 72 of file itkFEMImageMetricLoad.h.
| virtual Baseclass::Pointer itk::fem::ImageMetricLoad< TMoving, TFixed >::Clone | ( | ) | const [virtual] |
Create a new object from the existing one
Reimplemented from itk::fem::LoadElement.
| static FEMLightObject::Pointer itk::fem::FEMLightObject::CreateFromStream | ( | std::istream & | f, | |
| void * | info | |||
| ) | [static, inherited] |
Read object of any derived type from stream.
This static function creates an object of a class, which is derived from FEMLightObject. The class of object is first determined from the stream, then the object of that class is constructed using the FEMObjectFactory. Finally the data for this object is read from the stream, by calling the Read() member function.
| Float itk::fem::ImageMetricLoad< TMoving, TFixed >::EvaluateMetricGivenSolution | ( | Element::ArrayType * | el, | |
| Float | step = 1.0 | |||
| ) |
| VectorType itk::fem::ImageMetricLoad< TMoving, TFixed >::Fe | ( | VectorType | , | |
| VectorType | ||||
| ) |
Compute the image based load - implemented with ITK metric derivatives.
| VectorType itk::fem::ImageMetricLoad< TMoving, TFixed >::Fe1 | ( | VectorType | ) |
Compute the image based load - implemented with ITK metric derivatives.
| double itk::fem::ImageMetricLoad< TMoving, TFixed >::GetCurrentEnergy | ( | ) | [inline] |
Definition at line 275 of file itkFEMImageMetricLoad.h.
| FixedPointer itk::fem::ImageMetricLoad< TMoving, TFixed >::GetFixedImage | ( | ) | [inline] |
Definition at line 195 of file itkFEMImageMetricLoad.h.
| Float itk::fem::ImageMetricLoad< TMoving, TFixed >::GetMetric | ( | VectorType | InVec | ) |
This method returns the total metric evaluated over the image with respect to the current solution.
| GradientImageType* itk::fem::ImageMetricLoad< TMoving, TFixed >::GetMetricGradientImage | ( | ) | [inline] |
Set/Get the metric gradient image
Definition at line 268 of file itkFEMImageMetricLoad.h.
| MovingRadiusType itk::fem::ImageMetricLoad< TMoving, TFixed >::GetMetricRadius | ( | ) | [inline] |
Get the metric region size.
Definition at line 201 of file itkFEMImageMetricLoad.h.
| MovingPointer itk::fem::ImageMetricLoad< TMoving, TFixed >::GetMovingImage | ( | void | ) | [inline] |
Definition at line 193 of file itkFEMImageMetricLoad.h.
| unsigned int itk::fem::ImageMetricLoad< TMoving, TFixed >::GetNumberOfIntegrationPoints | ( | ) | [inline] |
Set/Get methods for the number of integration points to use in each 1-dimensional line integral when evaluating the load. This value is passed to the load implementation.
Definition at line 209 of file itkFEMImageMetricLoad.h.
| VectorType itk::fem::ImageMetricLoad< TMoving, TFixed >::GetPolynomialFitToMetric | ( | VectorType | PositionInElement, | |
| VectorType | SolutionAtPosition | |||
| ) |
This method returns the total metric evaluated over the image with respect to the current solution.
| Float itk::fem::ImageMetricLoad< TMoving, TFixed >::GetSolution | ( | unsigned int | i, | |
| unsigned int | which = 0 | |||
| ) | [inline] |
Definition at line 242 of file itkFEMImageMetricLoad.h.
References itk::fem::Solution::GetSolutionValue().
| Solution::ConstPointer itk::fem::ImageMetricLoad< TMoving, TFixed >::GetSolution | ( | ) | [inline, virtual] |
Sets the pointer to solution vector. This function is automatically called by the Solver class on every load object.
Some types of external Loads may need access to previous values of solution vector. If a derived class needs that, it should implement this function, and store the passed pointer accordingly. If the result vector is not required, the functionn should be left unimplemented, so that only the dummy implementation in base class is called.
- Parameters:
-
ptr Pointer to the object of Solution class.
Reimplemented from itk::fem::Load.
Definition at line 229 of file itkFEMImageMetricLoad.h.
| void itk::fem::ImageMetricLoad< TMoving, TFixed >::InitializeMetric | ( | void | ) |
| itk::fem::ImageMetricLoad< TMoving, TFixed >::itkStaticConstMacro | ( | ImageDimension | , | |
| unsigned | int, | |||
| MovingType::ImageDimension | ||||
| ) |
Dimensionality of input and output data is assumed to be the same.
| VectorType itk::fem::ImageMetricLoad< TMoving, TFixed >::MetricFiniteDiff | ( | VectorType | PositionInElement, | |
| VectorType | SolutionAtPosition | |||
| ) |
| static Self::Pointer itk::fem::ImageMetricLoad< TMoving, TFixed >::New | ( | void | ) | [inline, static] |
Object creation in an itk compatible way
Reimplemented from itk::fem::LoadElement.
Definition at line 72 of file itkFEMImageMetricLoad.h.
| static Baseclass* itk::fem::ImageMetricLoad< TMoving, TFixed >::NewImageMetricLoad | ( | void | ) | [inline, static] |
Definition at line 261 of file itkFEMImageMetricLoad.h.
| void itk::fem::ImageMetricLoad< TMoving, TFixed >::PrintCurrentEnergy | ( | ) | [inline] |
Definition at line 273 of file itkFEMImageMetricLoad.h.
| virtual void itk::fem::LoadElement::Read | ( | std::istream & | f, | |
| void * | info | |||
| ) | [virtual, inherited] |
pointers to element objects on which the load acts
Reimplemented from itk::fem::FEMLightObject.
Reimplemented in itk::fem::LoadEdge, itk::fem::LoadGravConst, itk::fem::LoadLandmark, and itk::fem::LoadTest< TClass >.
Referenced by itk::fem::LoadTest< TClass >::Read().
| void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetCurrentEnergy | ( | double | e | ) | [inline] |
Definition at line 277 of file itkFEMImageMetricLoad.h.
| void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetFixedImage | ( | FixedType * | T | ) | [inline] |
Define the target (fixed) image.
Definition at line 181 of file itkFEMImageMetricLoad.h.
| void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetGamma | ( | Float | s | ) | [inline] |
Scaling of the similarity energy term
Definition at line 224 of file itkFEMImageMetricLoad.h.
| void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetMetric | ( | MetricBaseTypePointer | MP | ) | [inline] |
Set/Get the Metric.
Definition at line 163 of file itkFEMImageMetricLoad.h.
| void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetMetricFixedImage | ( | FixedType * | T | ) | [inline] |
Define the target (fixed) image.
Definition at line 186 of file itkFEMImageMetricLoad.h.
| void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetMetricGradientImage | ( | GradientImageType * | g | ) | [inline] |
Set/Get the metric gradient image
Definition at line 266 of file itkFEMImageMetricLoad.h.
| void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetMetricMovingImage | ( | MovingType * | R | ) | [inline] |
Definition at line 174 of file itkFEMImageMetricLoad.h.
| void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetMetricRadius | ( | MovingRadiusType | T | ) | [inline] |
Define the metric region size.
Definition at line 198 of file itkFEMImageMetricLoad.h.
| void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetMovingImage | ( | MovingType * | R | ) | [inline] |
Define the reference (moving) image.
Definition at line 167 of file itkFEMImageMetricLoad.h.
| void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetNumberOfIntegrationPoints | ( | unsigned int | i | ) | [inline] |
Set/Get methods for the number of integration points to use in each 1-dimensional line integral when evaluating the load. This value is passed to the load implementation.
Definition at line 207 of file itkFEMImageMetricLoad.h.
| void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetSign | ( | Float | s | ) | [inline] |
Set the direction of the gradient (uphill or downhill). E.g. the mean squares metric should be minimized while NCC and PR should be maximized.
Definition at line 216 of file itkFEMImageMetricLoad.h.
| void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetSolution | ( | Solution::ConstPointer | ) | [inline, virtual] |
Sets the pointer to solution vector. This function is automatically called by the Solver class on every load object.
Some types of external Loads may need access to previous values of solution vector. If a derived class needs that, it should implement this function, and store the passed pointer accordingly. If the result vector is not required, the functionn should be left unimplemented, so that only the dummy implementation in base class is called.
- Parameters:
-
ptr Pointer to the object of Solution class.
Reimplemented from itk::fem::Load.
Definition at line 227 of file itkFEMImageMetricLoad.h.
| void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetTemp | ( | Float | s | ) | [inline] |
Set the sigma in a gaussian measure.
Definition at line 220 of file itkFEMImageMetricLoad.h.
| static void itk::fem::FEMLightObject::SkipWhiteSpace | ( | std::istream & | f | ) | [static, inherited] |
Helper function that skips all the whitespace and comments in an input stream.
| void itk::fem::LoadElement::Write | ( | std::ostream & | f | ) | const [virtual, inherited] |
Write an object to the output stream. Call this member to write the data members in the current object to the output stream. Here we also need to know which derived class we actually are, so that we can write the class name. The class name is obtained by calling the virtual ClassID() member function and passing the result to the FEMObjectFactory.
Implementations of Write member funtion in derived classes should first call the parent's implementation of Write and finaly write whatever they need.
Reimplemented from itk::fem::FEMLightObject.
Reimplemented in itk::fem::LoadEdge, itk::fem::LoadGravConst, itk::fem::LoadLandmark, and itk::fem::LoadTest< TClass >.
Referenced by itk::fem::LoadTest< TClass >::Write().
Member Data Documentation
const int itk::fem::ImageMetricLoad< TMoving, TFixed >::CLID [static] |
Class ID for FEM object factory
Reimplemented from itk::fem::LoadElement.
Definition at line 72 of file itkFEMImageMetricLoad.h.
int itk::fem::FEMLightObject::GN [inherited] |
Global number of an object (ID of an object) In general the ID's are required to be unique only within a specific type of derived classes (Elements, Nodes, ...) If the GN is not required, it can be ignored. (normally you need the GN when writing or reading objects to/from stream.
Definition at line 165 of file itkFEMLightObject.h.
Referenced by itk::fem::FEMLightObject::FEMLightObject().
const std::string itk::fem::FEMLightObject::whitespaces [static, inherited] |
Const string of all whitespace characters. This string is used by SkipWhiteSpace function.
Definition at line 135 of file itkFEMLightObject.h.
The documentation for this class was generated from the following file:
