Class Transform
java.lang.Object
org.itk.simple.Transform
- Direct Known Subclasses:
- AffineTransform,- BSplineTransform,- ComposeScaleSkewVersor3DTransform,- CompositeTransform,- DisplacementFieldTransform,- Euler2DTransform,- Euler3DTransform,- ScaleSkewVersor3DTransform,- ScaleTransform,- ScaleVersor3DTransform,- Similarity2DTransform,- Similarity3DTransform,- TranslationTransform,- VersorRigid3DTransform,- VersorTransform
A simplified wrapper around a variety of ITK transforms.
The interface to ITK transform objects to be used with the ImageRegistrationMethod, ResampleImageFilter and other SimpleITK process objects. The transforms are designed to
have a serialized array of parameters to facilitate optimization for
registration.
Provides a base class interface to any type of ITK transform. Objects
of this type may have their interface converted to a derived interface
while keeping the same reference to the ITK object.
Additionally, this class provides a basic interface to a composite
transforms.
See:
 itk::CompositeTransform
C++ includes: sitkTransform.h
- 
Field SummaryFields
- 
Constructor SummaryConstructorsModifierConstructorDescriptionitk::simple::Transform::Transform(unsigned int dimensions, TransformEnum type) Construct a specific transformation.protectedTransform(long cPtr, boolean cMemoryOwn) Transform(long dimensions, TransformEnum type) itk::simple::Transform::Transform(unsigned int dimensions, TransformEnum type) Construct a specific transformation.itk::simple::Transform::Transform(unsigned int dimensions, TransformEnum type) Construct a specific transformation.Transform(Image displacement, TransformEnum type) itk::simple::Transform::Transform(unsigned int dimensions, TransformEnum type) Construct a specific transformation.itk::simple::Transform::Transform(unsigned int dimensions, TransformEnum type) Construct a specific transformation.itk::simple::Transform::Transform(unsigned int dimensions, TransformEnum type) Construct a specific transformation.
- 
Method SummaryModifier and TypeMethodDescriptionvoiddelete()virtual itk::simple::Transform::~Transform()protected voidfinalize()protected static longlongunsigned int itk::simple::Transform::GetDimension() const Return the dimension of the Transform ( 2D or 3D )Transform itk::simple::Transform::GetInverse() const Return a new inverse transform of the same type as this.getName()virtual std::string itk::simple::Transform::GetName() const return user readable name for the SimpleITK transformlongunsigned int itk::simple::Transform::GetNumberOfFixedParameters() const Get the number of fixed parameterslongunsigned int itk::simple::Transform::GetNumberOfParameters() const Return the number of optimizable parametersTransformEnum itk::simple::Transform::GetTransformEnum() const Get the TransformEnum of the underlying Transform.booleanisLinear()virtual bool itk::simple::Transform::IsLinear() constvoidvoid itk::simple::Transform::MakeUnique() Performs actually coping if needed to make object unique.voidsetFixedParameters(VectorDouble parameters) voidvirtual void itk::simple::Transform::SetIdentity()booleanvirtual bool itk::simple::Transform::SetInverse() Try to change the current transform to it's inverse.voidsetParameters(VectorDouble parameters) protected static longswigRelease(Transform obj) toString()std::string itk::simple::Transform::ToString() consttransformPoint(VectorDouble point) std::vector<double> itk::simple::Transform::TransformPoint(const std::vector< double > &point) const Apply transform to a point.transformVector(VectorDouble vector, VectorDouble point) std::vector<double> itk::simple::Transform::TransformVector(const std::vector< double > &vector, const std::vector< double > &point) const Apply transform to a vector at a point.voidwriteTransform(String filename) void itk::simple::Transform::WriteTransform(const std::string &filename) const
- 
Field Details- 
swigCMemOwnprotected transient boolean swigCMemOwn
 
- 
- 
Constructor Details- 
Transformprotected Transform(long cPtr, boolean cMemoryOwn) 
- 
Transformpublic Transform()itk::simple::Transform::Transform(unsigned int dimensions, TransformEnum type) Construct a specific transformation. Deprecated This constructor will be removed in future releases.
- 
Transformitk::simple::Transform::Transform(unsigned int dimensions, TransformEnum type) Construct a specific transformation. Deprecated This constructor will be removed in future releases.
- 
Transformitk::simple::Transform::Transform(unsigned int dimensions, TransformEnum type) Construct a specific transformation. Deprecated This constructor will be removed in future releases.
- 
Transformitk::simple::Transform::Transform(unsigned int dimensions, TransformEnum type) Construct a specific transformation. Deprecated This constructor will be removed in future releases.
- 
Transformitk::simple::Transform::Transform(unsigned int dimensions, TransformEnum type) Construct a specific transformation. Deprecated This constructor will be removed in future releases.
- 
Transformitk::simple::Transform::Transform(unsigned int dimensions, TransformEnum type) Construct a specific transformation. Deprecated This constructor will be removed in future releases.
 
- 
- 
Method Details- 
getCPtr
- 
swigRelease
- 
finalize
- 
deletepublic void delete()virtual itk::simple::Transform::~Transform()
- 
getITKBase
- 
getDimensionpublic long getDimension()unsigned int itk::simple::Transform::GetDimension() const Return the dimension of the Transform ( 2D or 3D )
- 
setParameters
- 
getParameters
- 
getNumberOfParameterspublic long getNumberOfParameters()unsigned int itk::simple::Transform::GetNumberOfParameters() const Return the number of optimizable parameters
- 
setFixedParameters
- 
getFixedParameters
- 
getNumberOfFixedParameterspublic long getNumberOfFixedParameters()unsigned int itk::simple::Transform::GetNumberOfFixedParameters() const Get the number of fixed parameters
- 
transformPointstd::vector<double> itk::simple::Transform::TransformPoint(const std::vector< double > &point) const Apply transform to a point. The dimension of the point must match the transform.
- 
transformVectorstd::vector<double> itk::simple::Transform::TransformVector(const std::vector< double > &vector, const std::vector< double > &point) const Apply transform to a vector at a point. The ITK concept of a vector is a direction at a specific point, for example the difference between two points is a vector. For linear transforms the point does not matter, in general the vector is transformed by the Jacobian with respect to point position. The dimension of the vector and point must match the transform.
- 
writeTransformvoid itk::simple::Transform::WriteTransform(const std::string &filename) const
- 
isLinearpublic boolean isLinear()virtual bool itk::simple::Transform::IsLinear() const
- 
setIdentitypublic void setIdentity()virtual void itk::simple::Transform::SetIdentity()
- 
setInversepublic boolean setInverse()virtual bool itk::simple::Transform::SetInverse() Try to change the current transform to it's inverse. If the transform has an inverse, i.e. non-singular linear transforms, then a new ITK transform is created of the same type and this object is set to it. However not all transform have a direct inverse, if the inverse does not exist or fails false will be returned and this transform will not be modified.
- 
getInverseTransform itk::simple::Transform::GetInverse() const Return a new inverse transform of the same type as this. Creates a new transform object and tries to set the value to the inverse. As not all transform types have inverse and some transforms are not invertible, an exception will be throw is there is no inverse.
- 
toString
- 
getNamevirtual std::string itk::simple::Transform::GetName() const return user readable name for the SimpleITK transform
- 
makeUniquepublic void makeUnique()void itk::simple::Transform::MakeUnique() Performs actually coping if needed to make object unique. The Transform class by default performs lazy coping and assignment. This method make sure that coping actually happens to the itk::Transform pointed to is only pointed to by this object.
- 
getTransformEnumTransformEnum itk::simple::Transform::GetTransformEnum() const Get the TransformEnum of the underlying Transform. A SimpleITK Transform object can internally hold any ITK transform. This method returns the TransformEnum representing the internal ITK transform. This value may be used to identify which SimpleITK class the transform can be converted to.
 
-