LandmarksTransform.h

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

Program:   Visualization Toolkit
Module:    vtkLandmarkTransform.h

Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt orhttp://www.kitware.com/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 notice for more information.

=========================================================================*/
// .NAME vtkLandmarkTransform - a linear transform specified by two corresponding point sets
// .SECTION Description
// A vtkLandmarkTransform is defined by two sets of landmarks, the
// transform computed gives the best fit mapping one onto the other, in a
// least squares sense. The indices are taken to correspond, so point 1
// in the first set will get mapped close to point 1 in the second set,
// etc. Call SetSourceLandmarks and SetTargetLandmarks to specify the two
// sets of landmarks, ensure they have the same number of points.
// .SECTION Caveats
// Whenever you add, subtract, or set points you must call Modified()
// on the vtkPoints object, or the transformation might not update.
// .SECTION see also
// vtkLinearTransform

#ifndef __LandmarksTransform_h
#define __LandmarksTransform_h

#include <vtkCommonTransformsModule.h> // For export macro
#include "vtkLinearTransform.h"
#include "vtkFloatArray.h"
#include <vtkSystemIncludes.h> // m
#include <vtksys/SystemTools.hxx>  //m

#define VTK_LANDMARK_RIGIDBODY 6
#define VTK_LANDMARK_SIMILARITY 7
#define VTK_LANDMARK_AFFINE 12


class vtkMatrix4x4; // m
class vtkObjectFactory; // m
class vtkCommonTransformsModule; // m
class vtkLinearTransform; // m
class vtkFloatArray; // m

class LandmarksTransform : public vtkLinearTransform
{
public:
	static LandmarksTransform *New();

	vtkTypeMacro(LandmarksTransform, vtkLinearTransform);
	void PrintSelf(ostream& os, vtkIndent indent);

	// Description:
	// Specify the source and target landmark sets. The two sets must have
	// the same number of points.  If you add or change points in these objects,
	// you must call Modified() on them or the transformation might not update.
	void SetSourceLandmarks(vtkPoints *points);
	void SetTargetLandmarks(vtkPoints *points);
	void SetLandmarksWeight(vtkFloatArray *weight);

	vtkGetObjectMacro(SourceLandmarks, vtkPoints);
	vtkGetObjectMacro(TargetLandmarks, vtkPoints);

	// Description:
	// Set the number of degrees of freedom to constrain the solution to.
	// Rigidbody (VTK_LANDMARK_RIGIDBODY): rotation and translation only.
	// Similarity (VTK_LANDMARK_SIMILARITY): rotation, translation and
	//            isotropic scaling.
	// Affine (VTK_LANDMARK_AFFINE): collinearity is preserved.
	//        Ratios of distances along a line are preserved.
	// The default is similarity.
	vtkSetMacro(Mode, int);
	void SetModeToRigidBody() { this->SetMode(VTK_LANDMARK_RIGIDBODY); };
	void SetModeToSimilarity() { this->SetMode(VTK_LANDMARK_SIMILARITY); };
	void SetModeToAffine() { this->SetMode(VTK_LANDMARK_AFFINE); };

	// Description:
	// Get the current transformation mode.
	vtkGetMacro(Mode, int);
	const char *GetModeAsString();

	// Description:
	// Invert the transformation.  This is done by switching the
	// source and target landmarks.
	void Inverse();

	// Description:
	// Get the MTime.
//	unsigned long GetMTime();

	// Description:
	// Make another transform of the same type.
	vtkAbstractTransform *MakeTransform();

protected:
	LandmarksTransform();
	~LandmarksTransform();

	// Update the matrix from the quaternion.
	void InternalUpdate();

	// Description:
	// This method does no type checking, use DeepCopy instead.
	void InternalDeepCopy(vtkAbstractTransform *transform);

	vtkPoints* SourceLandmarks;
	vtkPoints* TargetLandmarks;
	vtkFloatArray* LandmarksWeight;


	int Mode;
private:
	LandmarksTransform(const LandmarksTransform&);  // Not implemented.
	void operator=(const LandmarksTransform&);  // Not implemented.
};

//BTX
/* const char * vtkLandmarksTransform::GetModeAsString() // attention 'inline' enlever
{
	switch (this->Mode)
	{
	case VTK_LANDMARK_RIGIDBODY:
		return "RigidBody";
	case VTK_LANDMARK_SIMILARITY:
		return "Similarity";
	case VTK_LANDMARK_AFFINE:
		return "Affine";
	default:
		return "Unrecognized";
	}
}*/
//ETX
#endif