- URL:
- https://<rasteranalysistools-url>/MultidimensionalPrincipalComponents
- Methods:
GET
- Version Introduced:
- 11.1
Description
The Multidimensional
task transforms multidimensional rasters into their principal components (either dimension reduction or spatial reduction components), loadings, and eigenvalues.
Request parameters
Parameter | Details |
---|---|
(Required) | The input multidimensional raster. The input raster can be the portal folder ID, portal item ID, image service URL, cloud multidimensional raster dataset, or shared multidimensional raster dataset. The dataset can be of type Cloud Raster Format (CRF) or a multidimensional mosaic dataset. The tool processes data along one dimension, such as a time series raster or a data cube defined by a nontime dimension [x, y, z]. If an input variable includes multiple dimensions, such as depth and time, the first dimension value will be used by default. Syntax: A JSON object describes the input raster.
|
(Required) | Specifies the method that will be used to perform principal component analysis.
Syntax: A String value representing the mode. Example
|
(Required) | The dimension name used to process the principal components. Syntax: A string representing the dimension name. Example
|
(Required) | The name of the output raster or table. When the When the Syntax: A JSON object that describes the name of the output principal components raster or table. Example
|
(Required) | The name of the output raster or table. When the When the Syntax: A JSON object that describes the name of the output loadings raster or table. Example
|
| The output eigenvalues table. Eigenvalues indicate the variance percentage of each component. They help define the number of principal components that are needed to represent the dataset. You can specify the name, or you can create an empty service using Portal Admin Sharing API and use the return JSON object as input to this parameter. Syntax: A String value representing the variable. Example
|
| The variable of the input multidimensional raster used in computation. If the input raster is multidimensional and no variable is specified, only the first variable will be analyzed, by default. Syntax: A string representing the variable. Example
|
| The number of principal components to compute, typically fewer than the number of input rasters or image bands. This parameter also takes the form of percentage (%). For example, 90% means the number of components that can explain 90 percent of variance in the data will be computed. Syntax: A String value representing the variable. Example
|
(Optional) | Contains additional settings that affect task processing. This parameter has the following settings:
|
|
The response format. The default response format is html. Values: |
Response
When you submit a request, the task assigns a unique job ID for the transaction.
Syntax:
{ "jobId": "<unique job identifier>", "jobStatus": "<job status>" }
After the initial request is submitted, you can use the job
to periodically check the status of the job and messages, as described in Check job status. Once the job has successfully completed, use the job
to retrieve the results. To track the status, you can make a request of the following form:
To track the status of the job:
http://<analysis url>/MultidimensionalPrincipalComponents/jobs/<jobId>
Access results
When the status of the job request is esri
, you can access the results of the analysis by making a request of the following form:
To access the output principal components:
http://<raster analysis url>/MultidimensionalPrincipalComponents/jobs/<jobId>/results/outputPrincipalComponentsName?token=<your token>&f=json
To access the output loadings table:
http://<raster analysis url>/MultidimensionalPrincipalComponents/jobs/<jobId>/results/outputLoadingsName?token=<your token>&f=json
To access the output eigenvalues table:
http://<raster analysis url>/MultidimensionalPrincipalComponents/jobs/<jobId>/results/outputEigenValuesName?token=<your token>&f=json