IDAX.PROJECT_PCA - Apply a PCA model

Use this stored procedure to project the input data along the principal components of the PCA model.

Authorization

The privileges held by the authorization ID of the statement must include the IDAX_USER role. Additionally, you must be the owner of the model or have the authority to alter it.

Before you start, ensure that you meet the following requirements:

  1. The input table must not be empty.
  2. The order of columns in the input table is unimportant. The column names in the input table, however, must match the column names of the table on which the PCA model is built.

Syntax

IDAX.PROJECT_PCA(in parameter_string varchar(32672))

Parameter descriptions

parameter_string
Mandatory one-string parameter that contains pairs of <parameter>=<value> entries that are separated by a comma.
Data type: VARCHAR(32672)
The following list shows the parameter values:
model
Mandatory.
The name of the PCA model that is to be applied.
Data type: VARCHAR(ANY)
id
Optional.
The column of the input table that identifies a sequence ID.
Data type: VARCHAR(128)
intable
Mandatory.
The name of the input table.
Data type: VARCHAR(ANY)
outtable
Mandatory.
The name of the output table where the predictions are stored.
Data type: VARCHAR(ANY)
pcnumber
Optional.
The number of principal components that are to be used for the projection.
The value for this parameter must not be higher than the number of principal components that are contained in the PCA model.
Default: all
Data type: VARCHAR(ANY)

Returned information

A result set that contains the string 't' (for 'true'), if the projection by using the PCA model was successful.

The output table that is created by the projection procedure has the following format:

Table 1. Columns of the output table for IDAX.PROJECT_PCA
Column Data type Description
ID BIGINT The ID column of the input table
PC<X> DOUBLE The projected value for the principal component <X>, where X is 1 <= n

Example

CALL IDAX.PROJECT_PCA('model=customer_churn_pca, intable=customer_churn_project_in, outtable=customer_churn_project_out');