Package	com.esri.baserver.tasks.analyses
Class	public class FindSimilarParameters
Inheritance	FindSimilarParameters AnalysisParameters AnalysisParameters BATaskParameters Object

The FindSimilarParameters class provides input parameters for the Find Similar task.

The analysis can be restricted to an analysis extent if the analysisExtent parameter is specified. The boundary layer sites are ranked based on similarity to a master site. If the masterSiteLayer parameter 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 parameter.

The variables to rank sites by are collected from two sources: the commonFields parameter specifies fields of the boundary layer and the summarizations parameter specifies demographic variables. If the demographic variables are specified, the dataHierarchy parameter can specify a name of data hierarchy to summarize demographic variables by.

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

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

For the Principal Component Analysis, the pcaRankSites parameter can specify the maximal number of sites with the best rank to be written to the output layer. If it is negative, all sites are ranked. The pcaEigenValue parameter specifies the eigenvalue boundary for Kaiser Criterion used in the Principal Component Analysis. The default value is 1 as recommended.

Output options for this task include rendering an output image (outputTypes.getMapImage) and/or creating a feature class for subsequent analysis (outputTypes.getFeatureClass). If no output options are specified, the required output options are specified as follows. If the renderingParameters parameter is specified, the image output is requested. If the outputAnalysisItem parameter is specified, the output analysis feature class will be stored in the repository. If both renderingParameters and outputAnalysisItem parameters are missing, the feature class output is requested.

View the examples

See also

---

                     
     var parameters : FindSimilarParameters = new FindSimilarParameters();
     
     // The Boundaries type could take either data as type 
     // com.esri.ags.tasks.FeatureSet, com.esri.baserver.FolderItem, or com.esri.bacore.StandardLayer.
     
     // Set boundaries with a valid data type.
     parameters.boundaries = new Boundaries(boundaries);
     
     // Set demographic variables to rank sites with.
     parameters.summarizations = ["TOTPOP_CY", "HHPOP_CY"];
     
     // Set ID of a geography layer to get demography data from.
     parameters.dataLayerID = "US.BlockGroups";
     
     // Set OID of the master site to 1.     
     parameters.masterSiteOID = 1;
     
     // The Principal Component Analysis is the default analysis type.
     //parameters.AnalysisType = FindSimilarAnalysisType.PCA;
     
     parameters.pcaRankSites = 10;   // Rank not more than 10 sites.
     parameters.pcaEigenvalue = 0.5; // The less value of this threshold, the more principal components are taken into account.
     
     // Optionally restrict analysis to myExtent that is a value of the Extent or Polygon type.
     //parameters.analysisExtent = myExtent;
     
     findSimilarTask.execute(parameters, new Responder(resultHandler, faultHandler));