com.esri.arcgis.datasourcesraster

Interface IMensuration

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMensurationProxy, Mensuration

public interface IMensuration
extends java.io.Serializable

COM Interface 'IMensuration'. Generated 9/24/2024 11:01:31 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description: 'Provides basic mensuration functionality utilizing sensor models that are compliant with the Community Sensor Model (CSM) specification.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID63ae4f70_bf55_480e_b2e0_49c5528bc4f2
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
void	convertAngular(int fromUnit, int toUnit, double inputValue, double[] pOutputValue) Converts angular measurement from 'fromUnit' to 'toUnit.
void	convertArea(int fromUnit, int toUnit, double inputValue, double[] pOutputValue) Converts area measurement from 'fromUnit' to 'toUnit.
java.lang.String	convertDisplayCoordUnit(int desiredDisplayUnit, IPoint pGeographicPt) Gets different coordinate unit display representation for input point (latitude, longitude).
void	convertErrCovarianceUnits(int inHorizAngularUnit, int outHorizAngularUnit, int inHorizLinearUnit, int outHorizLinearUnit, int inVertUnit, int outVertUnit, int horizontalUnitType, IDoubleArray pCovariance) Converts the covariance matrix's units.
void	convertLinear(int fromUnit, int toUnit, double inputValue, double[] pOutputValue) Converts linear measurement from 'fromUnit' to 'toUnit.
void	getAreaAndPerimeter(IPolygon pPolygon, IPolygonMeasurement[] ppPolygonMeasurement) Computes the area and perimeter of a polygon with no interior holes.
void	getAzimuthAngle(IPoint pFirstPoint, IPoint pSecondPoint, IAngularMeasurement[] ppAngleMeasurement) Computes the azimuth angle of the line connecting the two input map points.
void	getCentroid(IPolygon pPolygon, IPointMeasurement[] ppPointMeasurement) Gets the coordinates of the centroid of a polygon and the associated error covariance matrix.
IDoubleArray	getDefaultPointingErrCovariance() Default pointing error covariance matrix.
IRaster	getDEM() The DEM for the raster to be used for mensuration.
double	getDesiredPrecision() The iteration precision of the image-to-ground and ground-to-image calculations.
void	getDistance(IPoint pFirstPoint, IPoint pSecondPoint, IDistanceMeasurement[] ppDistMeasurement) Computes the actual distance between two points given their map points.
void	getHeightFromBaseAndTop(IPoint pBaseOfObject, IPoint pTopOfObject, IHeightMeasurement[] ppHtMeasurement) Estimates the height of an object given the base and the top map points of the object.
void	getHeightFromBaseAndTopShadow(IPoint pBaseOfObject, IPoint pTopShadowOfObject, IHeightMeasurement[] ppHtMeasurement) Estimates the height of an object given the map point of the object's base and the tip of the object's top shadow.
void	getHeightFromTopAndTopShadow(IPoint pTopOfObject, IPoint pTopShadowOfObject, IHeightMeasurement[] ppHtMeasurement) Estimates the height of an object given the top map point of the object and the tip of the object's top shadow.
java.lang.String	getName() The name of this IMensuration object.
void	getPoint(IPoint pPoint, IPointMeasurement[] ppPointMeasurement) Gets the coordinates of a map point and the associated error covariance matrix.
java.lang.String	getSensorModel() The name of the sensor model currently being used by this IMensuration object.
IPropertySet	getSensorModelProperties() The properties of the current sensor model.
java.lang.Object	getSensorModelProperty(java.lang.String propertyName) Gets a property value of the sensor model currently being used by this IMensuration.
java.lang.String	getTMName() The name of the TerrainModel used by this IMensuration object.
java.lang.String	getVersion() The version of this IMensuration.
boolean	isCanErrorPropagate() Indicates if the sensor model associated with the current image segment supports error propagation.
boolean	isCanMeasure() Indicates if the specified image segment can be used for mensuration.
boolean	isCanMeasureHeightBaseToTop() Indicates if the sensor model associated with the current image segment supports height mensuration.
boolean	isCanMeasureHeightBaseToTopShadow() Indicates if the sensor model associated with the current image segment supports shadow mensuration.
boolean	isCanMeasureHeightTopToTopShadow() Indicates if the sensor model associated with the current image segment supports shadow mensuration.
boolean	isCanMeasureMonoscopic() Indicates if the sensor model associated with the current image segment supports monoscopic mensuration.
boolean	isCanMeasureMultiImages() Indicates if the sensor model associated with the current image segment supports multi-image mensuration.
boolean	isCanMeasureStereoscopic() Indicates if the sensor model associated with the current image segment supports stereoscopic mensuration.
boolean	isValid() Indicates if all the required system parameters and resources of this IMensuration have been successfully initialized.
void	putSensorModelProperty(java.lang.String propertyKey, java.lang.String propertyValue) Sets a property value of the sensor model.
void	putTerrainParameters(java.lang.String terrainModelDataSrc, java.lang.String terrainModelName) Sets the name of the terrain model and the associated terrain model data source information.
void	setDefaultPointingErrCovariance(IDoubleArray ppPointingErrCovMatrix) Default pointing error covariance matrix.
void	setDEMByRef(IRaster ppRaster) The DEM for the raster to be used for mensuration.
void	setDesiredPrecision(double pPrecision) The iteration precision of the image-to-ground and ground-to-image calculations.
void	setRasterByRef(IRaster rhs1) The raster object to be used for mensuration.
void	significantFigures(double measurementValue, double uncertainty, java.lang.String[] pMeasurement, java.lang.String[] pUncertainty) Truncates input mensuration and uncertainty values based on acceptable rules for reporting measurement and uncertianty values.

Field Detail

IID63ae4f70_bf55_480e_b2e0_49c5528bc4f2

static final int IID63ae4f70_bf55_480e_b2e0_49c5528bc4f2

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

isCanErrorPropagate

boolean isCanErrorPropagate()
                     throws java.io.IOException,
                            AutomationException

Indicates if the sensor model associated with the current image segment supports error propagation.

Returns:

The pErrorPropagationCapable

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanMeasure

boolean isCanMeasure()
              throws java.io.IOException,
                     AutomationException

Indicates if the specified image segment can be used for mensuration.

Returns:

The pMensurationCapable

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanMeasureHeightBaseToTop

boolean isCanMeasureHeightBaseToTop()
                             throws java.io.IOException,
                                    AutomationException

Indicates if the sensor model associated with the current image segment supports height mensuration.

Returns:

The pHeightMensurationCapable

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanMeasureMonoscopic

boolean isCanMeasureMonoscopic()
                        throws java.io.IOException,
                               AutomationException

Indicates if the sensor model associated with the current image segment supports monoscopic mensuration.

Returns:

The pMonoscopicMensurationCapable

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanMeasureMultiImages

boolean isCanMeasureMultiImages()
                         throws java.io.IOException,
                                AutomationException

Indicates if the sensor model associated with the current image segment supports multi-image mensuration.

Returns:

The pMultiImageMensurationCapable

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanMeasureHeightTopToTopShadow

boolean isCanMeasureHeightTopToTopShadow()
                                  throws java.io.IOException,
                                         AutomationException

Indicates if the sensor model associated with the current image segment supports shadow mensuration.

Returns:

The pShadowMensurationCapable

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanMeasureHeightBaseToTopShadow

boolean isCanMeasureHeightBaseToTopShadow()
                                   throws java.io.IOException,
                                          AutomationException

Indicates if the sensor model associated with the current image segment supports shadow mensuration.

Returns:

The pShadowMensurationCapable

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanMeasureStereoscopic

boolean isCanMeasureStereoscopic()
                          throws java.io.IOException,
                                 AutomationException

Indicates if the sensor model associated with the current image segment supports stereoscopic mensuration.

Returns:

The pStereoscopicMensurationCapable

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertAngular

void convertAngular(int fromUnit,
                    int toUnit,
                    double inputValue,
                    double[] pOutputValue)
             throws java.io.IOException,
                    AutomationException

Converts angular measurement from 'fromUnit' to 'toUnit.

Parameters:

fromUnit - A com.esri.arcgis.system.esriDirectionUnits constant (in)

toUnit - A com.esri.arcgis.system.esriDirectionUnits constant (in)

inputValue - The inputValue (in)

pOutputValue - The pOutputValue (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertArea

void convertArea(int fromUnit,
                 int toUnit,
                 double inputValue,
                 double[] pOutputValue)
          throws java.io.IOException,
                 AutomationException

Converts area measurement from 'fromUnit' to 'toUnit.

Parameters:

fromUnit - A com.esri.arcgis.system.esriAreaUnits constant (in)

toUnit - A com.esri.arcgis.system.esriAreaUnits constant (in)

inputValue - The inputValue (in)

pOutputValue - The pOutputValue (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertDisplayCoordUnit

java.lang.String convertDisplayCoordUnit(int desiredDisplayUnit,
                                         IPoint pGeographicPt)
                                  throws java.io.IOException,
                                         AutomationException

Gets different coordinate unit display representation for input point (latitude, longitude).

Parameters:

desiredDisplayUnit - A com.esri.arcgis.datasourcesraster.esriDisplayCoordUnitType constant (in)

pGeographicPt - A reference to a com.esri.arcgis.geometry.IPoint (in)

Returns:

The pDisplayUnit

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertLinear

void convertLinear(int fromUnit,
                   int toUnit,
                   double inputValue,
                   double[] pOutputValue)
            throws java.io.IOException,
                   AutomationException

Converts linear measurement from 'fromUnit' to 'toUnit.

Parameters:

fromUnit - A com.esri.arcgis.system.esriUnits constant (in)

toUnit - A com.esri.arcgis.system.esriUnits constant (in)

inputValue - The inputValue (in)

pOutputValue - The pOutputValue (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertErrCovarianceUnits

void convertErrCovarianceUnits(int inHorizAngularUnit,
                               int outHorizAngularUnit,
                               int inHorizLinearUnit,
                               int outHorizLinearUnit,
                               int inVertUnit,
                               int outVertUnit,
                               int horizontalUnitType,
                               IDoubleArray pCovariance)
                        throws java.io.IOException,
                               AutomationException

Converts the covariance matrix's units.

Parameters:

inHorizAngularUnit - A com.esri.arcgis.system.esriDirectionUnits constant (in)

outHorizAngularUnit - A com.esri.arcgis.system.esriDirectionUnits constant (in)

inHorizLinearUnit - A com.esri.arcgis.system.esriUnits constant (in)

outHorizLinearUnit - A com.esri.arcgis.system.esriUnits constant (in)

inVertUnit - A com.esri.arcgis.system.esriUnits constant (in)

outVertUnit - A com.esri.arcgis.system.esriUnits constant (in)

horizontalUnitType - The horizontalUnitType (in)

pCovariance - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultPointingErrCovariance

IDoubleArray getDefaultPointingErrCovariance()
                                      throws java.io.IOException,
                                             AutomationException

Default pointing error covariance matrix.

Returns:

A reference to a com.esri.arcgis.system.IDoubleArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultPointingErrCovariance

void setDefaultPointingErrCovariance(IDoubleArray ppPointingErrCovMatrix)
                              throws java.io.IOException,
                                     AutomationException

Default pointing error covariance matrix.

Parameters:

ppPointingErrCovMatrix - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDEM

IRaster getDEM()
        throws java.io.IOException,
               AutomationException

The DEM for the raster to be used for mensuration.

Returns:

A reference to a com.esri.arcgis.geodatabase.IRaster

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDEMByRef

void setDEMByRef(IRaster ppRaster)
          throws java.io.IOException,
                 AutomationException

The DEM for the raster to be used for mensuration.

Parameters:

ppRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDesiredPrecision

double getDesiredPrecision()
                    throws java.io.IOException,
                           AutomationException

The iteration precision of the image-to-ground and ground-to-image calculations.

Returns:

The pPrecision

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDesiredPrecision

void setDesiredPrecision(double pPrecision)
                  throws java.io.IOException,
                         AutomationException

The iteration precision of the image-to-ground and ground-to-image calculations.

Parameters:

pPrecision - The pPrecision (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAreaAndPerimeter

void getAreaAndPerimeter(IPolygon pPolygon,
                         IPolygonMeasurement[] ppPolygonMeasurement)
                  throws java.io.IOException,
                         AutomationException

Computes the area and perimeter of a polygon with no interior holes.

Parameters:

pPolygon - A reference to a com.esri.arcgis.geometry.IPolygon (in)

ppPolygonMeasurement - A reference to a com.esri.arcgis.datasourcesraster.IPolygonMeasurement (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAzimuthAngle

void getAzimuthAngle(IPoint pFirstPoint,
                     IPoint pSecondPoint,
                     IAngularMeasurement[] ppAngleMeasurement)
              throws java.io.IOException,
                     AutomationException

Computes the azimuth angle of the line connecting the two input map points.

Parameters:

pFirstPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

pSecondPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

ppAngleMeasurement - A reference to a com.esri.arcgis.datasourcesraster.IAngularMeasurement (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCentroid

void getCentroid(IPolygon pPolygon,
                 IPointMeasurement[] ppPointMeasurement)
          throws java.io.IOException,
                 AutomationException

Gets the coordinates of the centroid of a polygon and the associated error covariance matrix.

Parameters:

pPolygon - A reference to a com.esri.arcgis.geometry.IPolygon (in)

ppPointMeasurement - A reference to a com.esri.arcgis.datasourcesraster.IPointMeasurement (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistance

void getDistance(IPoint pFirstPoint,
                 IPoint pSecondPoint,
                 IDistanceMeasurement[] ppDistMeasurement)
          throws java.io.IOException,
                 AutomationException

Computes the actual distance between two points given their map points.

Parameters:

pFirstPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

pSecondPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

ppDistMeasurement - A reference to a com.esri.arcgis.datasourcesraster.IDistanceMeasurement (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeightFromBaseAndTop

void getHeightFromBaseAndTop(IPoint pBaseOfObject,
                             IPoint pTopOfObject,
                             IHeightMeasurement[] ppHtMeasurement)
                      throws java.io.IOException,
                             AutomationException

Estimates the height of an object given the base and the top map points of the object.

Parameters:

pBaseOfObject - A reference to a com.esri.arcgis.geometry.IPoint (in)

pTopOfObject - A reference to a com.esri.arcgis.geometry.IPoint (in)

ppHtMeasurement - A reference to a com.esri.arcgis.datasourcesraster.IHeightMeasurement (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeightFromBaseAndTopShadow

void getHeightFromBaseAndTopShadow(IPoint pBaseOfObject,
                                   IPoint pTopShadowOfObject,
                                   IHeightMeasurement[] ppHtMeasurement)
                            throws java.io.IOException,
                                   AutomationException

Estimates the height of an object given the map point of the object's base and the tip of the object's top shadow.

Parameters:

pBaseOfObject - A reference to a com.esri.arcgis.geometry.IPoint (in)

pTopShadowOfObject - A reference to a com.esri.arcgis.geometry.IPoint (in)

ppHtMeasurement - A reference to a com.esri.arcgis.datasourcesraster.IHeightMeasurement (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeightFromTopAndTopShadow

void getHeightFromTopAndTopShadow(IPoint pTopOfObject,
                                  IPoint pTopShadowOfObject,
                                  IHeightMeasurement[] ppHtMeasurement)
                           throws java.io.IOException,
                                  AutomationException

Estimates the height of an object given the top map point of the object and the tip of the object's top shadow.

Parameters:

pTopOfObject - A reference to a com.esri.arcgis.geometry.IPoint (in)

pTopShadowOfObject - A reference to a com.esri.arcgis.geometry.IPoint (in)

ppHtMeasurement - A reference to a com.esri.arcgis.datasourcesraster.IHeightMeasurement (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPoint

void getPoint(IPoint pPoint,
              IPointMeasurement[] ppPointMeasurement)
       throws java.io.IOException,
              AutomationException

Gets the coordinates of a map point and the associated error covariance matrix.

Parameters:

pPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

ppPointMeasurement - A reference to a com.esri.arcgis.datasourcesraster.IPointMeasurement (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSensorModelProperty

java.lang.Object getSensorModelProperty(java.lang.String propertyName)
                                 throws java.io.IOException,
                                        AutomationException

Gets a property value of the sensor model currently being used by this IMensuration.

Parameters:

propertyName - The propertyName (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

java.lang.String getName()
                  throws java.io.IOException,
                         AutomationException

The name of this IMensuration object.

Returns:

The pName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putSensorModelProperty

void putSensorModelProperty(java.lang.String propertyKey,
                            java.lang.String propertyValue)
                     throws java.io.IOException,
                            AutomationException

Sets a property value of the sensor model.

Parameters:

propertyKey - The propertyKey (in)

propertyValue - The propertyValue (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putTerrainParameters

void putTerrainParameters(java.lang.String terrainModelDataSrc,
                          java.lang.String terrainModelName)
                   throws java.io.IOException,
                          AutomationException

Sets the name of the terrain model and the associated terrain model data source information.

Parameters:

terrainModelDataSrc - The terrainModelDataSrc (in)

terrainModelName - The terrainModelName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterByRef

void setRasterByRef(IRaster rhs1)
             throws java.io.IOException,
                    AutomationException

The raster object to be used for mensuration.

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSensorModel

java.lang.String getSensorModel()
                         throws java.io.IOException,
                                AutomationException

The name of the sensor model currently being used by this IMensuration object.

Returns:

The pSensorModelName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSensorModelProperties

IPropertySet getSensorModelProperties()
                               throws java.io.IOException,
                                      AutomationException

The properties of the current sensor model.

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

significantFigures

void significantFigures(double measurementValue,
                        double uncertainty,
                        java.lang.String[] pMeasurement,
                        java.lang.String[] pUncertainty)
                 throws java.io.IOException,
                        AutomationException

Truncates input mensuration and uncertainty values based on acceptable rules for reporting measurement and uncertianty values.

Parameters:

measurementValue - The measurementValue (in)

uncertainty - The uncertainty (in)

pMeasurement - The pMeasurement (out: use single element array)

pUncertainty - The pUncertainty (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTMName

java.lang.String getTMName()
                    throws java.io.IOException,
                           AutomationException

The name of the TerrainModel used by this IMensuration object.

Returns:

The pTerrainModelName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValid

boolean isValid()
         throws java.io.IOException,
                AutomationException

Indicates if all the required system parameters and resources of this IMensuration have been successfully initialized.

Returns:

The pSysInitialized

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVersion

java.lang.String getVersion()
                     throws java.io.IOException,
                            AutomationException

The version of this IMensuration.

Returns:

The pServiceVersion

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.