#include "SQDef.h"
#include "SQErrorCodes.h"
#include "SQStringVector.h"
#include "SQIntVector.h"
#include "SQVectorData.h"
#include "SQVariable.h"
Go to the source code of this file.
Classes | |
struct | tagSQ_Dataset |
struct | tagSQ_DatasetTypeVector |
Typedefs | |
typedef struct tagSQ_Dataset * | SQ_Dataset |
typedef enum SQ_DatasetTypeEnum | SQ_DatasetType |
typedef struct tagSQ_DatasetTypeVector * | SQ_DatasetTypeVector |
Enumerations | |
enum | SQ_DatasetTypeEnum { SQ_D_Standard =0, SQ_D_Spectral, SQ_D_Hierarchical, SQ_D_PLSDA, SQ_D_BatchLevel, SQ_D_ObservationLevel, SQ_D_BatchCondition, SQ_D_LagDistance } |
This file list the SQ_Dataset object used in Umetrics SIMCA-Q products.
typedef struct tagSQ_Dataset * SQ_Dataset |
The dataset handle used to identify an opened dataset. IMPORTANT: Always initialize it to NULL!
typedef enum SQ_DatasetTypeEnum SQ_DatasetType |
An enum defining the different dataset types.
typedef struct tagSQ_DatasetTypeVector * SQ_DatasetTypeVector |
The handle to identify a vector of dataset types.
enum SQ_DatasetTypeEnum |
An enum defining the different dataset types.
SQ_ErrorCode SQ_GetDataFromDatasetTypeVector | ( | const SQ_DatasetTypeVector | pVector, |
int | iPos, | ||
SQ_DatasetType * | pDatasetType | ||
) |
Gets the type of dataset.
[in] | pVector | The vector to get the data from. |
[in] | iPos | The position to get the data from. |
[in] | pDatasetType | The DatasetType. |
SQ_ErrorCode SQ_GetDataSetName | ( | SQ_Dataset | pDataset, |
char * | szDatasetName, | ||
int | iBufferLength | ||
) |
Retrieves the name of a dataset.
[in] | pDataset | The dataset to use, UTF-8 encoded. |
[in,out] | szDatasetName | The name of the dataset. The user is responsible to allocate and deallocate the buffer. |
[in] | iBufferLength | The length of the buffer. |
SQ_ErrorCode SQ_GetDataSetObservationIDName | ( | SQ_Dataset | pDataset, |
int | iNameIDIndex, | ||
char * | pszObservationIDName, | ||
int | iBufferLength | ||
) |
Retrieves the names of the observation IDs in the given data set.
[in] | pDataset | The dataset to use |
[in] | iNameIDIndex | The index of the Observation ID. 1 for the primary ID in the data set, 2 for the first level of secondary ID, 3 for the second level of secondary ID and so on. |
[in,out] | pszObservationIDName | The name of the observation ID, UTF-8 encoded. The user is responsible to allocate and deallocate the buffer. |
[in] | iBufferLength | The length of the buffer. |
SQ_ErrorCode SQ_GetDataSetObservationNames | ( | SQ_Dataset | pDataset, |
int | iNameIDIndex, | ||
SQ_StringVector * | pObservationNames | ||
) |
Retrieves the names of the observations in the given data set.
[in] | pDataset | The dataset to use |
[in] | iNameIDIndex | The index of the Observation ID. 1 for the primary ID in the data set, 2 for the first level of secondary ID, 3 for the second level of secondary ID and so on. |
[out] | pObservationNames | The names of the observations. The vector must be cleared with SQ_ClearStringVector. |
SQ_ErrorCode SQ_GetDataSetObservations | ( | SQ_Dataset | pDataset, |
SQ_IntVector * | pObservations, | ||
SQ_VectorData * | pVectorData | ||
) |
Retrieves the data for the observations in the given data set (ObsDS). If a variable is qualitative the index of the qualitative settings will be returned in the matrix. If the project option is set to reconstruct wavelet compression the data returned will reflect that.
[in] | pDataset | The dataset to use |
[in] | pObservations | A list of observation Indices to use. 1 for observation 1 in the data set, 2 for observation 2 and so on. NULL if all observations in the data set should be used. |
[out] | pVectorData | A pointer to the ObsDS vector data. Number of rows in vector data = number of observations chosen (length of pObservations). Number of columns in vector data = number of variables in the dataset. |
SQ_ErrorCode SQ_GetDataSetTypes | ( | SQ_Dataset | pDataset, |
SQ_DatasetTypeVector * | pTypeVector | ||
) |
Retrieves the types of a dataset.
[in] | pDataset | The dataset to use |
[out] | pTypeVector | The types of dataset. |
SQ_ErrorCode SQ_GetDataSetVariableIDName | ( | SQ_Dataset | pDataset, |
int | iNameIDIndex, | ||
char * | pszVariableIDName, | ||
int | iBufferLength | ||
) |
Retrieves the names of the variable IDs in the given data set.
[in] | pDataset | The dataset to use |
[in] | iNameIDIndex | The index of the Variable ID. 1 for the primary ID in the data set, 2 for the first level of secondary ID, 3 for the second level of secondary ID and so on. |
[in,out] | pszVariableIDName | The name of the variable ID (i.e. "Primary ID", "Secondary ID" etc.), UTF-8 encoded. The user is responsible to allocate and deallocate the buffer. |
[in] | iBufferLength | The length of the buffer. |
SQ_ErrorCode SQ_GetDataSetVariableNames | ( | SQ_Dataset | pDataset, |
SQ_VariableVector * | pVariableVector | ||
) |
Retrieves the names of the variables in the given data set.
[in] | pDataset | The dataset to use |
[out] | pVariableVector | The variables included in the dataset. |
SQ_ErrorCode SQ_GetDataSetVariables | ( | SQ_Dataset | pDataset, |
SQ_IntVector * | pVariables, | ||
SQ_VectorData * | pVectorData | ||
) |
Retrieves the data for the variables in the given data set (VarDS). If a variable is qualitative the index of the qualitative settings will be returned in the matrix.
[in] | pDataset | The dataset to use |
[in] | pVariables | A list of variable indices to use. 1 for variable 1 in the data set, 2 for variable 2 and so on. NULL if all variables in the data set should be used. |
[out] | pVectorData | A pointer to the VarDS vector data. Number of rows in vector data = number of variables chosen (length of pObservations). Number of columns in vector data = number of observations in the dataset. |
SQ_ErrorCode SQ_GetNumberOfObservationIDs | ( | SQ_Dataset | pDataset, |
int * | piNrObsIDs | ||
) |
Retrieves the number of different observations IDs in the dataset. If there exist both a primary ID and one level of secondary observation IDs, this equals to 2 observation IDs.
[in] | pDataset | The dataset to use |
[out] | piNrObsIDs | The number of observation IDs. |
SQ_ErrorCode SQ_GetNumberOfVariableIDs | ( | SQ_Dataset | pDataset, |
int * | piNrVarIDs | ||
) |
Retrieves the number of different variable IDs in the dataset. If there exist both a primary ID and one level of secondary variable IDs, this equals to 2 variable IDs.
[in] | pDataset | The dataset to use |
[out] | piNrVarIDs | The number of variable IDs. |
SQ_ErrorCode SQ_GetOriginalDataSetVariableNames | ( | SQ_Dataset | pDataset, |
SQ_VariableVector * | pVariableVector | ||
) |
Retrieves the original names of the variables in the given data set, before any processing. This function is only available for spectral datasets.
[in] | pDataset | The dataset to use |
[out] | pVariableVector | The original variables included in the dataset. |
SQ_ErrorCode SQ_GetSizeOfDatasetTypeVector | ( | const SQ_DatasetTypeVector | pVector, |
int * | piSize | ||
) |
Returns the size of the dataset types vector.
[in] | pVector | The vector to get the size of. |
[out] | piSize | The size of the vector or a negative number if an error occurred. |
Copyright (C) Sartorius Stedim Data Analytics AB - Generated by Doxygen