FRAMES | NO FRAMES
FindSimilarParameters Type

Parameters of  FindSimilar task.

Availability: Business Analyst Server.

class FindSimilarParameters : AnalysisParameters

Property Description
AnalysisExtent (optional) Data extent for analysis. Type ExtentData.
AnalysisType Analysis type. Type esriFindSimilarAnalysisType.
Boundaries Target polygon layer with sites that are ranked on similarity with the master site. Type DataLayer.
CommonFields (optional) Fields of the Boundaries layer used for ranking sites. Type String[].
DataHierarchy (optional) Name of a hierarchy of data layers to get demography for analysis. Type String. Use the GetDataHierarchies lookup operation to query available geography hierarchies. Available with Business Analyst Server 10.0.
MasterSiteLayer (optional) Polygon layer to get the master site from. Type DataLayer.
MasterSiteOID OID of the master site. Type Int32.
PCAEigenValue (optional) Eigenvalue boundary for Principal Component Analysis. Type Double.
PCARankSites (optional) Maximal number of sites to rank with Principal Component Analysis. Type Int32.
PercentValues Array of tolerance values in percents for Conventional Analysis. Type String.
Summarizations (optional) Demography variables used for ranking sites. Type String[].
ActiveDatasetID ID of the active dataset. Type String. Inherited from AnalysisParameters.
IsFullErrorMessage Mode for composing error messages. Type Boolean. Inherited from AnalysisParameters.
OutputSpatialReference An option specifying the spatial reference to return the output feature layer. Type SpatialReference. If this parameter is missing, the output record set will be returned in the default spatial reference. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.
ReturnGeometry An option specifying the presence of the shape attribute in the returned record set. Type Boolean. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.
Default: true.

Remarks

The analysis can be restricted to an analysis extent if the AnalysisExtent property is specified. Optional UseSelectedAreas property restricts the analysis to selected sites of the boundary layer.

The boundary layer sites are ranked on similarity with a master site. If the MasterSiteLayer property is specified, the master site is selected from the master site layer. Otherwise, the master site is selected from the boundary layer. In both cases, the master site is selected by the OID value specified in the MasterSiteOID property.

The variables to rank sites by are collected from two sources: the CommonFields property specifies fields of the boundary layer and the Summarizations property specifies demography variables. If the demography fields are specified, the DataLayerID property should specify the ID of a geography layer to summarize demography variables by.

Two types of analysis are supported—the Conventional Analysis and the Principal Component Analysis.

For the Conventional Analysis, the PercentValues array specifies the tolerance values in percents for ranking variables: at the beginning for the boundary layer fields and after that for the demography variables. The Conventional Analysis is limited to five variables.

For the Principal Component Analysis, the PCARankSites property can specify the maximum number of sites to be ranked. If its value is -1 or null, all sites are ranked. The PCAEigenValue property specifies the eigenvalue boundary for Kaiser Criterion used in the Principal Component Analysis. The default value of 1 as recommended.

NOTE: Since Business Analyst Server 10.0, the DataLayerID property is replaced with an optional DataHierarchy property.

See Also