Interface IPolynomialXform
- Namespace
- ESRI.ArcGIS.DatasourcesRaster
- Assembly
- ESRI.Server.DatasourcesRaster.dll
Provides access to members that control a polynomial transform.
[Guid("B8A34DB7-E73B-4A09-8815-A7B729E33504")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IPolynomialXform : IGeodataXform
Remarks
The IPolynomialXform interface provides methods and properties used to create the PolynomialXform object and perform error analysis of the polynomial transformation.
You can create a PolynomialXform in two ways: One is to use DefineFromControlPoints with two sets of control points, one being source and one being target, to construct a polynomial. The other way is to set the polynomial coefficients directly using DefineFromCoefficients if the polynomial coefficients are known.
A polynomial transformation is an approximate transformation and the IPolynomialXform interface provides two ways to calculate the system residuals and RMS. One is based on the control points using GetSystemResidual and GetSystemRMS methods; and the other is based on a set of check points using CheckResidualRMS method.
Properties
Domains
IGeometryCollection Domains { get; }
Property Value
IsIdentity
bool IsIdentity { get; }
Property Value
Order
The polynomial order (0-3).
int Order { get; }
Property Value
SpatialReference
ISpatialReference SpatialReference { get; set; }
Property Value
Methods
ApplyRotation(esriTransformDirection, IPoint, double)
Applies a rotation to the polynomial.
void ApplyRotation(esriTransformDirection direction, IPoint pPivotPoint, double degree)
Parameters
directionesriTransformDirectionpPivotPointIPointdegreedouble
Remarks
ApplyRotation method append an xform to the existing PolynomialXform. To define a rotation transformation for work with raster data using this method, you must define both forward and inverse transformation.
For example, to define a rotation of 45 degree unclockwise, you need to call
pPolynomialXform.ApplyRotate TransformationForward, 45
pPolynomialXform.ApplyRotate TransformationReverse, -45
ApplyScale(esriTransformDirection, double, double)
Applies a scale to the polynomial.
void ApplyScale(esriTransformDirection direction, double scaleX, double scaleY)
Parameters
directionesriTransformDirectionscaleXdoublescaleYdouble
Remarks
ApplyScale method appends an xform to the existing PolynomialXform. To define an scale transformation to work with raster data using this method, you must define both forward and inverse transformations.
For example, to define a scale transformation, you need to call
pPolynomialXform.ApplyScale TransformationForward, 10
pPolynomialXform.ApplyScale TransformationReverse, 1/10
ApplyShift(esriTransformDirection, double, double)
Applies a shift to the polynomial.
void ApplyShift(esriTransformDirection direction, double shiftX, double shiftY)
Parameters
directionesriTransformDirectionshiftXdoubleshiftYdouble
Remarks
ApplyShift method append an xform to the existing PolynomialXform. To define a shift transformation to work with raster data using this method, you must define both forward and inverse transformations.
For example, to define a shift transformation, you need to call
pPolynomialXform.ApplyShift TransformationForward, 10
pPolynomialXform.ApplyShift TransformationReverse, -10
CheckResidualRMS(IPointCollection, IPointCollection, esriTransformDirection, out object, out double)
Gets the residuals and RMS using checking points.
void CheckResidualRMS(IPointCollection CheckingsSurcePoints, IPointCollection CheckingsTargetPoints, esriTransformDirection direction, out object pResidual, out double rms)
Parameters
CheckingsSurcePointsIPointCollectionCheckingsTargetPointsIPointCollectiondirectionesriTransformDirectionpResidualobjectrmsdouble
Remarks
Get residual on a set of user specified check points. The residual returned is a variant array of double type.
DefineFromCoefficients(ref object, ref object, int)
Defines a polynomial XForm from polynomial (order: 0-3) coefficients .
void DefineFromCoefficients(ref object pForwardPolyCoef, ref object pReversePolyCoef, int Order)
Parameters
Remarks
The polynomial coefficients are a variant array of nx2 elements of double type, where n=3 for the first order, 6 for the second order and 10 for the third order.
To define a PolynomialXform to work with raster dataset, coefficients for both forward case and reverse case must be set.
You can define a PolynomialXform that performs one direction transformation, for transforming other type of data, such as forward transformation, pass Null to reverse coefficient argument.
DefineFromControlPoints(IPointCollection, IPointCollection, int)
Defines a polynomial (order: 0-3) XForm from control points.
void DefineFromControlPoints(IPointCollection pSrcPoints, IPointCollection pTarPoints, int Order)
Parameters
pSrcPointsIPointCollectionpTarPointsIPointCollectionOrderint
Remarks
The polynomial order can be 1,2,3 and the number of the non-correlated control points required must be at least 3, 6, and 10 respectively.
GetCoefficients(esriTransformDirection)
Gets the coefficients of the polynomial.
object GetCoefficients(esriTransformDirection direction)
Parameters
directionesriTransformDirection
Returns
Remarks
The polynomial coefficients are in a variant array of nx2 elements of double type, where n=3 for the first order, 6 for the second order and 10 for the third order.
GetControlPoints(out IPointCollection, out IPointCollection)
Gets control points used in defining the polynomial.
void GetControlPoints(out IPointCollection ppSrcPoints, out IPointCollection ppTarPoints)
Parameters
ppSrcPointsIPointCollectionppTarPointsIPointCollection
GetSystemRMS(esriTransformDirection)
Gets the system RMS.
double GetSystemRMS(esriTransformDirection direction)
Parameters
directionesriTransformDirection
Returns
GetSystemResidual(esriTransformDirection)
Gets the system residuals.
object GetSystemResidual(esriTransformDirection direction)
Parameters
directionesriTransformDirection
Returns
Remarks
The residual returned is variant array of double type, the size of the array is the number of control points used in creating the PolynomialXform.
Transform(esriTransformDirection, int, ref WKSPoint)
void Transform(esriTransformDirection Direction, int npoints, ref WKSPoint points)
Parameters
DirectionesriTransformDirectionnpointsintpointsWKSPoint
TransformCellsize(esriTransformDirection, ref double, ref double, IEnvelope)
void TransformCellsize(esriTransformDirection Direction, ref double dx, ref double dy, IEnvelope AreaOfInterest)
Parameters
DirectionesriTransformDirectiondxdoubledydoubleAreaOfInterestIEnvelope
TransformExtent(esriTransformDirection, IEnvelope)
void TransformExtent(esriTransformDirection Direction, IEnvelope Extent)
Parameters
DirectionesriTransformDirectionExtentIEnvelope
TransformPoints(esriTransformDirection, IPointCollection)
void TransformPoints(esriTransformDirection Direction, IPointCollection points)
Parameters
DirectionesriTransformDirectionpointsIPointCollection