com.bayesia.api

Class APIUtils

java.lang.Object

com.bayesia.api.APIUtils

public class APIUtils
extends java.lang.Object

The class APIUtils is a utility class where some enumerations and other static stuff are declared

Version:

4.2

Author:

Bayesia S.A.S.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	APIUtils.DISCRETIZATION Enumeration of the available discretization algorithms.
static class	APIUtils.LEARNING_ALGORITHM Enumeration of the available learning algorithms.
static class	APIUtils.LETTER_CASE Enumeration of the available case formats for StringFormatter.
static class	APIUtils.MEAN_MODE Enumeration of the mean observation's modes
static class	APIUtils.NODE_SORTING_METHOD Enumeration of the node sorting methods.

Constructor Summary

Constructors

Constructor and Description
APIUtils()

Method Summary

Modifier and Type	Method and Description
static double[][]	discretize(DiscretizationSettings discretizationSettings, double[] values, double[] weights) Perform a discretization of the given values and weights accordingly to the discretization settings provided.
static double[][]	discretize(TargetedDiscretizationSettings discretizationSettings, double[] values, double[] weights, short[] classes) Perform a discretization of the given values and weights accordingly to the discretization settings provided.
static java.awt.image.BufferedImage	getBufferedImage(ResizableIcon icon) Returns a BufferedImage generated from the given icon.
static NetworkDescriptor	getNetworkDescriptor(BayesianNetworkTransferHandler networkHandler) Return and instance of NetworkDescriptor representing the Bayesian Network read from the given InputStream.
static NetworkDescriptor	getNetworkDescriptor(java.io.InputStream stream) Return and instance of NetworkDescriptor representing the Bayesian Network read from the given InputStream.
static NetworkDescriptor	getNetworkDescriptor(java.lang.String fileName) Return and instance of NetworkDescriptor representing the Bayesian Network stored in the given file.
static ResizableIcon	getResizableIcon(java.awt.image.BufferedImage image) Returns a ResizableIcon built from the given BufferedImage
static ResizableIcon	getResizableIcon(java.io.File file) Returns the icon loaded from the given file.
static ResizableIcon	getResizableIcon(java.net.URL imageUrl) Returns a ResizableIcon loaded from the given URL.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

APIUtils

public APIUtils()

Method Detail

getNetworkDescriptor

public static final NetworkDescriptor getNetworkDescriptor(java.lang.String fileName)

Return and instance of NetworkDescriptor representing the Bayesian Network stored in the given file.

Parameters:

fileName - the name of the xbl file where the Bayesian network is stored in

Returns:

a NetworkDescriptor describing the network

getNetworkDescriptor

public static final NetworkDescriptor getNetworkDescriptor(java.io.InputStream stream)

Return and instance of NetworkDescriptor representing the Bayesian Network read from the given InputStream.

Parameters:

stream - the stream from where the network is read

Returns:

a NetworkDescriptor describing the network

getNetworkDescriptor

public static final NetworkDescriptor getNetworkDescriptor(BayesianNetworkTransferHandler networkHandler)

Return and instance of NetworkDescriptor representing the Bayesian Network read from the given InputStream.

Parameters:

networkHandler - networkHandler the transfer handler containing the network

Returns:

a NetworkDescriptor describing the network

discretize

public static double[][] discretize(DiscretizationSettings discretizationSettings,
                                    double[] values,
                                    double[] weights)

Perform a discretization of the given values and weights accordingly to the discretization settings provided. This method is intended to be use for not targeted discretization. When the discretization is successful, it returns an array of the intervals found. The size of the main array is the number of intervals. For each interval, an array of size 2 gives the minimum and the maximum values of this interval. The minimum value found is intervals[0][0], and the maximum value is intervals[n-1][1], where n is the number of intervals found.

Parameters:

discretizationSettings - the settings defining the discretization algorithm to use

values - the values to be discretized

weights - the weights associated to the values

Returns:

an array containing the intervals found by the discretization

See Also:

DiscretizationSettings, APIUtils.DISCRETIZATION

discretize

public static double[][] discretize(TargetedDiscretizationSettings discretizationSettings,
                                    double[] values,
                                    double[] weights,
                                    short[] classes)

Perform a discretization of the given values and weights accordingly to the discretization settings provided. The discretization is done with respect to the given classes. This method is intended to be use for targeted discretization only. When the discretization is successful, it returns an array of the intervals found. The size of the main array is the number of intervals. For each interval, an array of size 2 gives the minimum and the maximum values of this interval. The minimum value found is intervals[0][0], and the maximum value is intervals[n-1][1], where n is the number of intervals found.

Parameters:

discretizationSettings - the settings defining the targeted discretization algorithm to use

values - the values to be discretized

weights - the weights associated to the values

classes - the target classes used by the discretization algorithm

Returns:

an array containing the intervals found by the discretization

See Also:

TargetedDiscretizationSettings, APIUtils.DISCRETIZATION.DECISION_TREE

getResizableIcon

public static ResizableIcon getResizableIcon(java.awt.image.BufferedImage image)

Returns a ResizableIcon built from the given BufferedImage

Parameters:

image - an instance of BufferedImage

Returns:

the created icon

getBufferedImage

public static java.awt.image.BufferedImage getBufferedImage(ResizableIcon icon)

Returns a BufferedImage generated from the given icon. This image has the same size as the icon.

Parameters:

icon - an instance of ResizableIcon

Returns:

an instance of BufferedImage on which the icon is painted

getResizableIcon

public static ResizableIcon getResizableIcon(java.net.URL imageUrl)
                                      throws java.io.IOException

Returns a ResizableIcon loaded from the given URL.

Parameters:

imageUrl - an URL to a valid image (png, jpg, gif and svg)

Returns:

the loaded icon

Throws:

java.io.IOException - when an error occurs while loading

getResizableIcon

public static ResizableIcon getResizableIcon(java.io.File file)
                                      throws java.io.IOException

Returns the icon loaded from the given file. This file must contain a valid image (png, jpg, gif and svg)

Parameters:

file - the file where the icon is stored.

Returns:

the loaded icon

Throws:

java.io.IOException - when an error occurs while loading