boonnano 1
C++ library giving usage access to the Boon Logic Nano technology
 
Loading...
Searching...
No Matches
CBoonNano Class Reference

Main class of processing data. More...

#include <boonnano.h>

Public Member Functions

 CBoonNano (CNanoBackend *NanoBackend=nullptr)
 Initialize nano.
 
int ClusterData (float *Pattern, CClusterStats *AdvancedAnalytics=nullptr)
 Cluster float pattern.
 
void ClusterData (float *PatternBuffer, uint32_t NumPatterns, int *ResultBuffer, CClusterStats *AdvancedAnalyticsBuffer=nullptr)
 Cluster float patterns.
 
uint32_t ClusterData (float *PatternBuffer, uint32_t NumPatterns, int *ResultBuffer, uint32_t StepCount, CClusterStats *AdvancedAnalyticsBuffer=nullptr)
 Cluster overlapping float patterns.
 
int ClusterData (int16_t *Pattern, CClusterStats *AdvancedAnalytics=nullptr)
 Cluster int16 pattern.
 
void ClusterData (int16_t *PatternBuffer, uint32_t NumPatterns, int *ResultBuffer, CClusterStats *AdvancedAnalyticsBuffer=nullptr)
 Cluster int16 patterns.
 
uint32_t ClusterData (int16_t *PatternBuffer, uint32_t NumPatterns, int *ResultBuffer, uint32_t StepCount, CClusterStats *AdvancedAnalyticsBuffer=nullptr)
 Cluster overlapping int16 patterns.
 
int ClusterData (uint16_t *Pattern, CClusterStats *AdvancedAnalytics=nullptr)
 Cluster uint16 pattern.
 
void ClusterData (uint16_t *PatternBuffer, uint32_t NumPatterns, int *ResultBuffer, CClusterStats *AdvancedAnalyticsBuffer=nullptr)
 Cluster uint16 patterns.
 
uint32_t ClusterData (uint16_t *PatternBuffer, uint32_t NumPatterns, int *ResultBuffer, uint32_t StepCount, CClusterStats *AdvancedAnalyticsBuffer=nullptr)
 Cluster overlapping uint16 patterns.
 
uint32_t GetAnomalyIndex (int ID)
 Get anomaly index for cluster.
 
uint64_t GetClusterSize (int ID) const
 Get number of patterns in the cluster.
 
uint16_t GetCurrentClusterCount () const
 Get last error message.
 
uint32_t GetDistanceIndex (int ID)
 Get the distance index for the cluster.
 
char * GetErrorMessage ()
 
uint32_t GetFrequencyIndex (int ID)
 Get cluster frequency.
 
bool GetGhostClusterEnabled () const
 Whether or not new clusters can be created.
 
uint64_t GetInferenceCountWhenClusterWasCreated (int ID) const
 Get the start index of the cluster.
 
float GetInterClusterDistance (int ID1, int ID2)
 Get distance between two clusters.
 
bool GetLearningMode () const
 Whether or not new clusters can be created.
 
uint16_t GetMaxClusters () const
 Get maximum number of clusters allowed.
 
bool GetNanoClippingDetection () const
 Whether or not a new cluster can trigger on out of bounds.
 
CNanoConfigParametersGetNanoConfig ()
 Get configuration.
 
int GetNearestNeighbor (float *Pattern, float &Confidence)
 Get closest cluster to the pattern (float)
 
int GetNearestNeighbor (int ID)
 Get nearest cluster.
 
int GetNearestNeighbor (int16_t *Pattern, float &Confidence)
 Get closest cluster to the pattern (int16)
 
int GetNearestNeighbor (uint16_t *Pattern, float &Confidence)
 Get closest cluster to the pattern (uint16)
 
uint16_t GetNoveltyIndex (int ID)
 Get novelty index for cluster.
 
uint64_t GetNumOfPatternsClustered () const
 Get number of patterns processed.
 
uint16_t GetPatternLength ()
 Length of a pattern.
 
void GetPCA (int ID, uint32_t &X, uint32_t &Y, uint32_t &Z)
 Get PCA representation of cluster.
 
float GetPercentVariation () const
 Get configured percent variation.
 
uint32_t GetProbabilityIndex (int ID)
 Get cluster probability.
 
bool GetRootCause (int ID, float *RootCause)
 Get root cause array from cluster.
 
bool GetRootCause (uint8_t *Pattern, uint32_t PatternSizeInElements, float *RootCause)
 Get root cause array from pattern.
 
std::string GetStatusString (int CurrentIndent=0, int AdditionalIndent=4)
 Print string of object variables.
 
uint16_t GetStreamingWindowSize () const
 Get configured streaming window size.
 
bool InitComplete () const
 Get backend initialization status.
 
bool MaxClusterCountReached ()
 Determine if clusters were maxed out.
 
uint16_t ProbeClusterCount (float *PatternBuffer, uint32_t NumPatterns, uint32_t MaxClusters)
 Get number of clusters for float data.
 
uint16_t ProbeClusterCount (int16_t *PatternBuffer, uint32_t NumPatterns, uint32_t MaxClusters)
 Get number of clusters for int16 data.
 
uint16_t ProbeClusterCount (uint16_t *PatternBuffer, uint32_t NumPatterns, uint32_t MaxClusters)
 Get number of clusters for uint16 data.
 
bool PruneClusterIDs (const uint32_t *IDArray, uint32_t NumIDs)
 Remove cluster ID(s)
 
void Reset (bool BackendReset=true)
 Clear object variables.
 
void ResetClusters ()
 Resets the model's clusters.
 
bool Serialize (const char *ArchivePath, bool IsLoading)
 Write/read object into/from a binary file.
 
bool Serialize (const char *VarPath, const char *ThisVarName, struct archive *Archive, bool IsLoading)
 
void SetGhostClusterEnabled (bool GhostClustersEnabled)
 Enable/disable ghost cluster creation.
 
void SetLearningMode (bool LearningOn)
 Enable/disable new cluster creation.
 
void SetMaxClusters (uint16_t MaxClusters)
 Set the cluster count limit.
 
void SetNanoClippingDetection (bool ClippingOn)
 Turn on/off value out of bounds anomalies.
 
bool Setup (CNanoConfigParameters &NanoConfig)
 Set configuration parameters for model clustering.
 

Public Attributes

CTypeConverter * m_TypeConverter
 Object for managing data type and conversions.
 

Detailed Description

Includes all the function steps needed to process data through the algorithm

Examples
base-example.cpp, full-example.cpp, and results.cpp.

The documentation for this class was generated from the following file: