Class FrameXformClass
- Namespace
- ESRI.ArcGIS.DatasourcesRaster
- Assembly
- ESRI.Server.DatasourcesRaster.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("D3E347AC-80E5-4A75-B4A8-1E7AC5D50710")]
public class FrameXformClass : FrameXform, IGeodataXform2, IFrameXform2, IFrameXform, IGeodataXform, IRasterXform, ISensorXform, ITransformation, IClone, IPersistStream, IPersist, IDocumentVersionSupportGEN, IXMLSerialize, IXMLVersionSupport
- Inheritance
-
FrameXformClass
- Implements
- Inherited Members
Constructors
FrameXformClass()
public FrameXformClass()
Explicit Interface Implementations
ApplyCurvatureAndRefraction
Indicates if the adjustment of earth curvature and refraction is applied.
virtual bool ApplyCurvatureAndRefraction { get; set; }
Returns
Remarks
Optional parameter indicating whether the earth curvature and atmospheric distortion correction should be applied. By default it is not. It is primarily used for high altitude aerial photography, as the effect is minimal in most aerial surveys.
Assign(IClone)
Assigns the properties of src to the receiver.
virtual void Assign(IClone src)
Parameters
srcIClone
AverageZ
The average Z in meters.
virtual double AverageZ { get; set; }
Returns
Remarks
When performing ortho-rectification, a source of elevation data is required. This is often a digital elevation model (DEM) dataset. If a DEM is not available, the average elevation in the area of interest must be set for best results.
CameraID
The camera ID.
virtual string CameraID { get; set; }
Returns
Clone()
Clones the receiver and assigns the result to *clone.
virtual IClone Clone()
Returns
CompareCameraDefinition(IFrameXform)
Compares if it has the same camera definition as a given frame geodata transform.
virtual bool CompareCameraDefinition(IFrameXform pFrameXf)
Parameters
pFrameXfIFrameXform
Returns
ComputeFootprint(esriTransformDirection, IGeometry, int)
Computes the footprint in a given direction for a given input extent/footprint.
virtual IGeometry ComputeFootprint(esriTransformDirection direction, IGeometry pExtent, int MaximumVertices)
Parameters
directionesriTransformDirectionpExtentIGeometryMaximumVerticesint
Returns
ConstantZ
The constant Z value in meters.
virtual double ConstantZ { get; set; }
Returns
Remarks
This property can be used to set a constant elevation across the image when DEM method is not used.
ConvertToSupportedObject(esriArcGISVersion)
Convert the object to another object that is supported.
virtual object ConvertToSupportedObject(esriArcGISVersion docVersion)
Parameters
docVersionesriArcGISVersion
Returns
Remarks
This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.
CorrectGeoid
Indicates if Geoid correction is needed.
virtual bool CorrectGeoid { get; set; }
Returns
Remarks
If the property is set to true, the DEM used in orthorectification will be corrected to use the true elevation.
DEM
The Digital Elevation Model (DEM).
virtual IRaster DEM { get; set; }
Returns
Deserialize(IXMLSerializeData)
Deserializes an object from XML.
virtual void Deserialize(IXMLSerializeData data)
Parameters
dataIXMLSerializeData
Domains
The domains in output space.
virtual IGeometryCollection Domains { get; }
Returns
EarthRadius
The earth radius in meters.
virtual double EarthRadius { get; set; }
Returns
EnableKonrady
Indicates if the Konrady adjustment to be applied.
virtual bool EnableKonrady { get; set; }
Returns
Remarks
This parameter controls whether radial distortion correction is performed or not. If the corrections were applied during post-processing of the images, set this value to false. Otherwise, provide the Konrady coefficients. Be sure to set the correct Konrady type (ESRI or USGS) that corresponds to the coefficients.
FocalLength
The focal length in micron.
virtual double FocalLength { get; set; }
Returns
FullExtent
The full output extent within which this xform is applied.
virtual IEnvelope FullExtent { get; set; }
Returns
GetClassID(out Guid)
virtual void GetClassID(out Guid pClassID)
Parameters
pClassIDGuid
GetDistortionTable(out IDoubleArray, out IDoubleArray)
The distortion tables.
virtual void GetDistortionTable(out IDoubleArray ppDistanceInMillimeters, out IDoubleArray ppDistortionInMicrons)
Parameters
ppDistanceInMillimetersIDoubleArrayppDistortionInMicronsIDoubleArray
GetSizeMax(out _ULARGE_INTEGER)
virtual void GetSizeMax(out _ULARGE_INTEGER pcbSize)
Parameters
pcbSize_ULARGE_INTEGER
GetZ(double, double)
Gets Z value for a given location (x,y) in map space.
virtual double GetZ(double x, double y)
Parameters
Returns
IFrameXform2_ApplyCurvatureAndRefraction
virtual bool IFrameXform2_ApplyCurvatureAndRefraction { get; set; }
Returns
IFrameXform2_AverageZ
virtual double IFrameXform2_AverageZ { get; set; }
Returns
IFrameXform2_Domains
virtual IGeometryCollection IFrameXform2_Domains { get; }
Returns
IFrameXform2_EarthRadius
virtual double IFrameXform2_EarthRadius { get; set; }
Returns
IFrameXform2_EnableKonrady
virtual bool IFrameXform2_EnableKonrady { get; set; }
Returns
IFrameXform2_FocalLength
virtual double IFrameXform2_FocalLength { get; set; }
Returns
IFrameXform2_GetDistortionTable(out IDoubleArray, out IDoubleArray)
virtual void IFrameXform2_GetDistortionTable(out IDoubleArray ppDistanceInMillimeters, out IDoubleArray ppDistortionInMicrons)
Parameters
ppDistanceInMillimetersIDoubleArrayppDistortionInMicronsIDoubleArray
IFrameXform2_InteriorOrientation
virtual IGeodataXform IFrameXform2_InteriorOrientation { get; set; }
Returns
IFrameXform2_IsIdentity
virtual bool IFrameXform2_IsIdentity { get; }
Returns
IFrameXform2_KonradyParameters
virtual object IFrameXform2_KonradyParameters { get; set; }
Returns
IFrameXform2_KonradyType
virtual esriRasterKonradyType IFrameXform2_KonradyType { get; set; }
Returns
IFrameXform2_LSR
virtual IGeodataXform IFrameXform2_LSR { get; set; }
Returns
IFrameXform2_PerspectiveCenter
virtual IPoint IFrameXform2_PerspectiveCenter { get; set; }
Returns
IFrameXform2_PerspectiveMatrix
virtual object IFrameXform2_PerspectiveMatrix { get; set; }
Returns
IFrameXform2_PerspectivePolarity
virtual int IFrameXform2_PerspectivePolarity { get; set; }
Returns
IFrameXform2_PrincipalPoint
virtual IPoint IFrameXform2_PrincipalPoint { get; set; }
Returns
IFrameXform2_PutDistortionTable(IDoubleArray, IDoubleArray)
virtual void IFrameXform2_PutDistortionTable(IDoubleArray pDistanceInMillimeters, IDoubleArray pDistortionInMicrons)
Parameters
pDistanceInMillimetersIDoubleArraypDistortionInMicronsIDoubleArray
IFrameXform2_PutInteriorOrientationParameters(esriTransformDirection, object)
virtual void IFrameXform2_PutInteriorOrientationParameters(esriTransformDirection direction, object Parameters)
Parameters
directionesriTransformDirectionParametersobject
IFrameXform2_PutPerspectiveAngles(double, double, double, bool)
virtual void IFrameXform2_PutPerspectiveAngles(double omega, double phi, double kappa, bool clockwise)
Parameters
IFrameXform2_QueryKonradyParameters(ref double)
virtual void IFrameXform2_QueryKonradyParameters(ref double pK)
Parameters
pKdouble
IFrameXform2_QueryPerspectiveAngles(out double, out double, out double, out bool)
virtual void IFrameXform2_QueryPerspectiveAngles(out double pOmega, out double pPhi, out double pKappa, out bool pClockwise)
Parameters
IFrameXform2_QueryPerspectiveMatrix(ref double)
virtual void IFrameXform2_QueryPerspectiveMatrix(ref double pMatrix)
Parameters
pMatrixdouble
IFrameXform2_Residuals
virtual IDoubleArray IFrameXform2_Residuals { get; }
Returns
IFrameXform2_SpatialReference
virtual ISpatialReference IFrameXform2_SpatialReference { get; set; }
Returns
IFrameXform2_Transform(esriTransformDirection, int, ref WKSPoint)
virtual void IFrameXform2_Transform(esriTransformDirection Direction, int npoints, ref WKSPoint points)
Parameters
DirectionesriTransformDirectionnpointsintpointsWKSPoint
IFrameXform2_TransformCellsize(esriTransformDirection, ref double, ref double, IEnvelope)
virtual void IFrameXform2_TransformCellsize(esriTransformDirection Direction, ref double dx, ref double dy, IEnvelope AreaOfInterest)
Parameters
DirectionesriTransformDirectiondxdoubledydoubleAreaOfInterestIEnvelope
IFrameXform2_TransformExtent(esriTransformDirection, IEnvelope)
virtual void IFrameXform2_TransformExtent(esriTransformDirection Direction, IEnvelope Extent)
Parameters
DirectionesriTransformDirectionExtentIEnvelope
IFrameXform2_TransformPoints(esriTransformDirection, IPointCollection)
virtual void IFrameXform2_TransformPoints(esriTransformDirection Direction, IPointCollection points)
Parameters
DirectionesriTransformDirectionpointsIPointCollection
IFrameXform_Domains
virtual IGeometryCollection IFrameXform_Domains { get; }
Returns
IFrameXform_IsIdentity
virtual bool IFrameXform_IsIdentity { get; }
Returns
IFrameXform_SpatialReference
virtual ISpatialReference IFrameXform_SpatialReference { get; set; }
Returns
IFrameXform_Transform(esriTransformDirection, int, ref WKSPoint)
virtual void IFrameXform_Transform(esriTransformDirection Direction, int npoints, ref WKSPoint points)
Parameters
DirectionesriTransformDirectionnpointsintpointsWKSPoint
IFrameXform_TransformCellsize(esriTransformDirection, ref double, ref double, IEnvelope)
virtual void IFrameXform_TransformCellsize(esriTransformDirection Direction, ref double dx, ref double dy, IEnvelope AreaOfInterest)
Parameters
DirectionesriTransformDirectiondxdoubledydoubleAreaOfInterestIEnvelope
IFrameXform_TransformExtent(esriTransformDirection, IEnvelope)
virtual void IFrameXform_TransformExtent(esriTransformDirection Direction, IEnvelope Extent)
Parameters
DirectionesriTransformDirectionExtentIEnvelope
IFrameXform_TransformPoints(esriTransformDirection, IPointCollection)
virtual void IFrameXform_TransformPoints(esriTransformDirection Direction, IPointCollection points)
Parameters
DirectionesriTransformDirectionpointsIPointCollection
ImageTopAngle
The angle of the top of image.
virtual double ImageTopAngle { get; set; }
Returns
InteriorOrientation
The interior orientation as an affine transformation.
virtual IGeodataXform InteriorOrientation { get; set; }
Returns
IsDirty()
virtual void IsDirty()
IsEqual(IClone)
Indicates if the receiver and other have the same properties.
virtual bool IsEqual(IClone other)
Parameters
otherIClone
Returns
IsIdentical(IClone)
Indicates if the receiver and other are the same object.
virtual bool IsIdentical(IClone other)
Parameters
otherIClone
Returns
IsIdentity
Indicates if this geodata transform is an identity transform.
virtual bool IsIdentity { get; }
Returns
IsSupportedAtVersion(esriArcGISVersion)
Is this object valid at the given document version.
virtual bool IsSupportedAtVersion(esriArcGISVersion docVersion)
Parameters
docVersionesriArcGISVersion
Returns
Remarks
Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.
KonradyParameters
The Konrady adjustment parameters.
virtual object KonradyParameters { get; set; }
Returns
Remarks
Konrady coefficients are used to correct radial distortions in standard frame cameras. Three double precision values are stored and used when displaying the imagery. See the ESRIRasterKonradyType enumeration values to see how these coefficients are applied.
KonradyType
The Konrady calculation method.
virtual esriRasterKonradyType KonradyType { get; set; }
Returns
LSR
The LSR-To-USR conversion.
virtual IGeodataXform LSR { get; set; }
Returns
Load(IStream)
virtual void Load(IStream pstm)
Parameters
pstmIStream
MinNamespaceSupported
The minimum namespace the class can serialize to (eg the 90 namespace).
virtual string MinNamespaceSupported { get; }
Returns
PerspectiveCenter
The sensor position.
virtual IPoint PerspectiveCenter { get; set; }
Returns
PerspectiveMatrix
The specified sensor orientation as an orthogonal rotation matrix.
virtual object PerspectiveMatrix { get; set; }
Returns
Remarks
The perspective matrix is a 3x3 rotation matrix that adjusts the imagery based on the three perspective angles associated with an image frame. The three angles represent the roll, pitch and yaw of the aircraft (omega, phi, kappa) when the exposure was taken.
There are two ways to set the perspective matrix: put_PerspectiveMatrix( ) and PutPerspectiveAngles( ). Both methods populate the 3x3 rotation matrix. The choice of which to use is largely based on what information is available in the aerial photography project file.
PerspectivePolarity
The sensor polarity.
virtual int PerspectivePolarity { get; set; }
Returns
Remarks
An optional parameter that defines the direction of the Z axis. The default value is -1, and should only be changed for sensor that use that convention.
Prepare(int, double, double, IEnvelope)
Prepares the xform for a given extent and cellsize within a domain.
virtual void Prepare(int iDomain, double Dx, double Dy, IEnvelope pExtent)
Parameters
PrincipalPoint
The film principal point.
virtual IPoint PrincipalPoint { get; set; }
Returns
PutAircraftOrientation(double, double, double, double, bool)
Sets the sensor exterior orientation (rotation matrix) using aircraft orientation angles in degrees.
virtual void PutAircraftOrientation(double rollDeg, double pitchDeg, double headingDeg, double cameraMountAngleDeg, bool clockwise)
Parameters
PutDistortionTable(IDoubleArray, IDoubleArray)
The distortion tables to calculate Konrady coefficients and residuals.
virtual void PutDistortionTable(IDoubleArray pDistanceInMillimeters, IDoubleArray pDistortionInMicrons)
Parameters
pDistanceInMillimetersIDoubleArraypDistortionInMicronsIDoubleArray
Remarks
An alternative to put_KonradyParameters, this method allows the use of the distortion tables contained in the camera calibration report to calculate the Konrady coefficients. It is critical to ensure that the units are correct for the two arrays that are passed in. The first array is the radial distance in mm, while the second array is the distortion errors in microns. Either ESRI or USGS conventions can be used to calculate the coefficients. See the ESRIRasterKonradyType enumeration for more details.
PutInteriorOrientationParameters(esriTransformDirection, object)
Puts the interior orientation parameters.
virtual void PutInteriorOrientationParameters(esriTransformDirection direction, object Parameters)
Parameters
directionesriTransformDirectionParametersobject
Remarks
See putref_InteriorOrientation for more details.
PutPerspectiveAngles(double, double, double, bool)
Puts the sensor exterior orientation as a set of rotation angles in degrees.
virtual void PutPerspectiveAngles(double omega, double phi, double kappa, bool clockwise)
Parameters
Remarks
An alternative to put_PerspectiveMatrix( ) for establishing the rotation matrix.
QueryAircraftOrientation(out double, out double, out double, out bool)
Queries aircraft orientation angles in degrees from the sensor exterior orientation (rotation matrix).
virtual void QueryAircraftOrientation(out double pRollDeg, out double pPitchDeg, out double pTopOfFrameDeg, out bool pClockwise)
Parameters
QueryCameraAxisAngles(out double, out double)
Computes and returns the apparent position of the camera. The values for Azimuth and Elevation are in degrees.
virtual void QueryCameraAxisAngles(out double pCameraAzimuth, out double pCameraElevation)
Parameters
QueryKonradyParameters(ref double)
Queries the Konrady adjustment parameterrs.
virtual void QueryKonradyParameters(ref double pK)
Parameters
pKdouble
QueryPerspectiveAngles(out double, out double, out double, out bool)
Queries the sensor exterior orientation as a set of rotation angles in degrees.
virtual void QueryPerspectiveAngles(out double pOmega, out double pPhi, out double pKappa, out bool pClockwise)
Parameters
QueryPerspectiveMatrix(ref double)
Queries the perspective matrix.
virtual void QueryPerspectiveMatrix(ref double pMatrix)
Parameters
pMatrixdouble
RequireDEM
Indicates if DEM is required for applying this transform.
virtual bool RequireDEM { get; set; }
Returns
Residuals
The residuals for distortion table points.
virtual IDoubleArray Residuals { get; }
Returns
Remarks
After using the distortion table to calculate the Konrady coefficients, it is important to check the residuals to detect if any anomalies, for instance an error when inputing the data values. Under normal circumstances, the residuals should be just a few microns. Larger residuals could indicate a problem with the data points.
Save(IStream, int)
virtual void Save(IStream pstm, int fClearDirty)
Parameters
Serialize(IXMLSerializeData)
Serializes an object to XML.
virtual void Serialize(IXMLSerializeData data)
Parameters
dataIXMLSerializeData
Simplify()
Simplifies into a simple geodataxform.
virtual IGeodataXform Simplify()
Returns
SpatialReference
The output spatial reference after applying this transform.
virtual ISpatialReference SpatialReference { get; set; }
Returns
Transform(esriTransformDirection, int, ref WKSPoint)
Transforms a set of points in a given direction.
virtual void Transform(esriTransformDirection Direction, int npoints, ref WKSPoint points)
Parameters
DirectionesriTransformDirectionnpointsintpointsWKSPoint
Transform3D(esriTransformDirection, int, ref WKSPointZ)
Transforms a set of 3D points in a given direction.
virtual void Transform3D(esriTransformDirection direction, int npoints, ref WKSPointZ points)
Parameters
directionesriTransformDirectionnpointsintpointsWKSPointZ
Transform3DPoints(esriTransformDirection, IPointCollection)
Transforms a collection of 3D points in a given direction
virtual void Transform3DPoints(esriTransformDirection direction, IPointCollection pPoints)
Parameters
directionesriTransformDirectionpPointsIPointCollection
TransformCellsize(esriTransformDirection, ref double, ref double, IEnvelope)
Transforms a cellsize in a given direction.
virtual void TransformCellsize(esriTransformDirection Direction, ref double dx, ref double dy, IEnvelope AreaOfInterest)
Parameters
DirectionesriTransformDirectiondxdoubledydoubleAreaOfInterestIEnvelope
TransformExtent(esriTransformDirection, IEnvelope)
Transforms an extent in a given direction.
virtual void TransformExtent(esriTransformDirection Direction, IEnvelope Extent)
Parameters
DirectionesriTransformDirectionExtentIEnvelope
TransformMeasuresFF(esriTransformDirection, int, ref double, ref double)
Transforms floating point measures to floating point measures (or do the inverse).
virtual void TransformMeasuresFF(esriTransformDirection Direction, int cMeasures, ref double inMeasures, ref double outMeasures)
Parameters
DirectionesriTransformDirectioncMeasuresintinMeasuresdoubleoutMeasuresdouble
TransformMeasuresFI(esriTransformDirection, int, ref double, ref int)
Transforms floating point measures to integer measures (or do the inverse).
virtual void TransformMeasuresFI(esriTransformDirection Direction, int cMeasures, ref double inMeasures, ref int outMeasures)
Parameters
DirectionesriTransformDirectioncMeasuresintinMeasuresdoubleoutMeasuresint
TransformMeasuresIF(esriTransformDirection, int, ref int, ref double)
Transforms integer measures to floating point measures (or do the inverse).
virtual void TransformMeasuresIF(esriTransformDirection Direction, int cMeasures, ref int inMeasures, ref double outMeasures)
Parameters
DirectionesriTransformDirectioncMeasuresintinMeasuresintoutMeasuresdouble
TransformMeasuresII(esriTransformDirection, int, ref int, ref int)
Transforms integer measures to integer measures (or do the inverse).
virtual void TransformMeasuresII(esriTransformDirection Direction, int cMeasures, ref int inMeasures, ref int outMeasures)
Parameters
DirectionesriTransformDirectioncMeasuresintinMeasuresintoutMeasuresint
TransformPoints(esriTransformDirection, IPointCollection)
Transforms a point collection in a given direction
virtual void TransformPoints(esriTransformDirection Direction, IPointCollection points)
Parameters
DirectionesriTransformDirectionpointsIPointCollection
TransformPointsFF(esriTransformDirection, int, ref double, ref double)
Transforms floating point points to floating point points (or do the inverse).
virtual void TransformPointsFF(esriTransformDirection Direction, int cPoints, ref double inPoints, ref double outPoints)
Parameters
DirectionesriTransformDirectioncPointsintinPointsdoubleoutPointsdouble
Remarks
The cPoints parameter is the number of points you wish to transform. inPoints and outPoints are one-dimensional arrays so you must interleave coordinate pairs into the arrays.
The cPoints parameter is the number of points you wish to transform. inPoints and outPoints are one-dimensional arrays so you must interleave coordinate pairs into the arrays. This code is a shift of the points to the east and north.
IAffineTransformation2D transform = new AffineTransformation2D() as IAffineTransformation2D;
//Sets the type of transformation moving the values 10 degrees East and 20 degrees North
transform.Move(10, 20);
//Create two single dimensioned arrays for the inPoints and OutPoints
double[] inPoints = new double[4];
double[] outPoints = new double[4];
//Interleave the Longitude and Latitude value for two points 1.1E 5.2N, 2.3E 6.4N
inPoints[0]=1.1; //Longitude point 1
inPoints[1]=5.2; //Latitude point 1
inPoints[2]=2.3; //Longitude point 2
inPoints[3] = 6.4; //Latitude point 2
transform.TransformPointsFF(0,2,ref inPoints[0],ref outPoints[0]);
Debug.Print(outPoints[0].ToString()); //11.1
Debug.Print(outPoints[1].ToString()); //25.2
Debug.Print(outPoints[2].ToString()); //12.3
Debug.Print(outPoints[3].ToString()); //26.4
TransformPointsFI(esriTransformDirection, int, ref double, ref int)
Transforms floating point points to integer points (or do the inverse).
virtual void TransformPointsFI(esriTransformDirection Direction, int cPoints, ref double inPoints, ref int outPoints)
Parameters
DirectionesriTransformDirectioncPointsintinPointsdoubleoutPointsint
Remarks
The cPoints parameter is the number of points you wish to transform. inPoints and outPoints are one-dimensional arrays so you must interleave coordinate pairs into the arrays.
TransformPointsIF(esriTransformDirection, int, ref int, ref double)
Transforms integer points to floating point points (or do the inverse).
virtual void TransformPointsIF(esriTransformDirection Direction, int cPoints, ref int inPoints, ref double outPoints)
Parameters
DirectionesriTransformDirectioncPointsintinPointsintoutPointsdouble
Remarks
The cPoints parameter is the number of points you wish to transform. inPoints and outPoints are one-dimensional arrays so you must interleave coordinate pairs into the arrays.
TransformPointsII(esriTransformDirection, int, ref int, ref int)
Transforms integer points to integer points (or do the inverse).
virtual void TransformPointsII(esriTransformDirection Direction, int cPoints, ref int inPoints, ref int outPoints)
Parameters
DirectionesriTransformDirectioncPointsintinPointsintoutPointsint
Remarks
The cPoints parameter is the number of points you wish to transform. inPoints and outPoints are one-dimensional arrays so you must interleave coordinate pairs into the arrays.
ZFactor
The conversion factor from DEM Z unit to meters.
virtual double ZFactor { get; set; }
Returns
Remarks
A factor that converts the unit of the DEM to meter
ZOffset
The Z offset in meters applied to DEM.
virtual double ZOffset { get; set; }
Returns
Remarks
If the DEM data used is not based on sea level, this property can be used to do the adjustment.