Utils (Simbrain API)

java.lang.Object
- org.simbrain.util.Utils

public class Utils
extends java.lang.Object

Utils. Utility class for simbrain package.

Constructor Summary

Constructors
Constructor and Description

Utils()

Constructors
Constructor and Description
`Utils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static float`	`colorToFloat(java.awt.Color clr)` Returns the Hue associated with a Color.
`static <T> T[]`	`concatenate(T[] A, T[] B)` Concatenate two arrays A, B to produce a third array A + B.
`static void`	`displayLocalHtmlInBrowser(java.lang.String url)` Launch an .html page using the system's default browser.
`static java.lang.String`	`doubleArrayToString(double[] data)` Utility to class to convert arrays of doubles to strings.
`static java.lang.String[]`	`doubleArrayToStringArray(double[] line)` Converts an array of doubles into an array of Strings of those doubles.
`static java.lang.String`	`doubleMatrixToString(double[][] matrix)` Convert a 2-d array of doubles to a string.
`static java.lang.String[][]`	`doubleMatrixToStringMatrix(double[][] matrix)` Converts a matrix of doubles into a matrix of Strings representing those doubles.
`static double`	`doubleParsable(javax.swing.JTextField tField)` Tests whether the string in a text field is parsable into a double.
`static double`	`doubleParsable(java.lang.String text)` Like `doubleParsable(JTextField)` but checks for the formatting of a string rather than a text field.
`static java.awt.Color`	`floatToHue(float fclr)` Converts a floating point value into a color in HSB, with Saturation and Brightness 1.
`static java.lang.String`	`getDir(java.io.File theFile)` Get the directory component of a file.
`static double[][]`	`getDoubleMatrix(java.io.File theFile)` Read a csv (comma-separated-values) files.
`static java.lang.String`	`getNameFromPath(java.lang.String thePath)` Extract file name from a path description.
`(package private) static boolean`	`getOSMatches(java.lang.String osNamePrefix)` Decides if the operating system matches.
`static java.lang.String`	`getRelativePath(java.lang.String baseDir, java.lang.String absolutePath)` Helper method to create a relative path for use in saving simulation files which refer to files within directories.
`static java.util.Properties`	`getSimbrainProperties()` Return the Simbrain properties file, or null if it is not found.
`static java.lang.String[][]`	`getStringMatrix(java.io.File theFile)` Read a csv (comma-separated-values) files.
`static java.lang.String`	`getTimeString()` Helper method that returns the date and time in a format that can be used to create filenames.
`static java.lang.String`	`getVectorString(double[] theVec, java.lang.String delimiter)` Convert an array of doubles into a String.
`static double[]`	`getVectorString(java.lang.String theVec, java.lang.String delimiter)` Convert a delimited string of doubles into an array of doubles.
`static java.util.Collection`	`intersection(java.util.Collection a, java.util.Collection b)` Re-implementation of same method from org.apache.commons.collections.CollectionUtils.
`static <T> boolean`	`intersects(java.util.Collection<T> A, java.util.Collection<T> B)` True if collection A has a non-empty intersection with collection B, false otherwise.
`static boolean`	`isMacOSX()` Determines whether the system is a Mac os x.
`static java.lang.Integer`	`parseInteger(javax.swing.JTextField tField)` Parses the given String in the text field into an integer.
`static java.lang.Integer`	`parseInteger(java.lang.String text)` The same as `parseInteger(JTextField)` except using a String directly as an input.
`static double[]`	`parseVectorString(java.lang.String vectorString)` Converts a String representation of a vector (e.g.
`static java.lang.String`	`readFileContents(java.io.File file)` Returns the contents of a file as a String.
`static java.lang.String`	`round(double num, int precision)` Returns a string rounded to the desired precision.
`static java.util.Collection`	`select(java.util.Collection selection, Predicate filter)` Reimplementation of same method from org.apache.commons.collections.CollectionUtils.
`static int`	`setAlpha(int alpha, int rgbIntColor)` Sets the alpha of the color represented by rgBInt to the value specified in alpha and returns the resulting color.
`static int`	`setBlue(int blue, int rgbIntColor)` Sets the blue value of the color represented by rgbIntColor to the value specified by blue and returns the resulting color.
`static int`	`setGreen(int green, int rgbIntColor)` Sets the green value of the color represented by rgbIntColor to the value specified by green and returns the resulting color.
`static int`	`setRed(int red, int rgbIntColor)` Sets the red value of the color represented by rgbIntColor to the value specified by red and returns the resulting color.
`static void`	`showHelpPage(java.lang.String helpPage)` Display a documentation page under {simbrainhome}/docs/...
`static double[]`	`stringArrayToDoubleArray(java.lang.String[] line)` Converts an array of strings containing doubles into an array of doubles.
`static java.util.Collection`	`union(java.util.Collection a, java.util.Collection b)` Re-implementation of same method from org.apache.commons.collections.CollectionUtils.
`static void`	`writeMatrix(double[][] data, java.io.File theFile)` Write a matrix of doubles to a file.
`static void`	`writeMatrix(java.lang.String[][] data, java.io.File theFile)` Save data as CSV (comma-separated-value) file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Utils
```
public Utils()
```
- Method Detail
  - getTimeString
```
public static java.lang.String getTimeString()
```
    Helper method that returns the date and time in a format that can be used to create filenames.
    
    Returns:
    
    the formatted time string
  - getDoubleMatrix
```
public static double[][] getDoubleMatrix(java.io.File theFile)
```
    Read a csv (comma-separated-values) files.
    
    Parameters:
    
    theFile - the file to read in
    
    Returns:
    
    an two-dimensional array of comma-separated values
  - getStringMatrix
```
public static java.lang.String[][] getStringMatrix(java.io.File theFile)
```
    Read a csv (comma-separated-values) files.
    
    Parameters:
    
    theFile - the file to read in
    
    Returns:
    
    an two-dimensional array of comma-separated values
  - writeMatrix
```
public static void writeMatrix(double[][] data,
                               java.io.File theFile)
```
    Write a matrix of doubles to a file.
    
    Parameters:
    
    data - the matrix of doubles to write
    
    theFile - the file to write to
  - writeMatrix
```
public static void writeMatrix(java.lang.String[][] data,
                               java.io.File theFile)
```
    Save data as CSV (comma-separated-value) file.
    
    Parameters:
    
    data - Data to be written
    
    theFile - File to be written to
  - getRelativePath
```
public static java.lang.String getRelativePath(java.lang.String baseDir,
                                               java.lang.String absolutePath)
```
    Helper method to create a relative path for use in saving simulation files which refer to files within directories. Subtracts the absolutePath of the local user directory from the absolute path of the file to be saved, and converts file-separators into forward slashes, which are used for saving simulation files.
    
    Parameters:
    
    baseDir - absolute path of the local simbrain directory.
    
    absolutePath - the absolute path of the file to be saved
    
    Returns:
    
    the relative path from the local directory to the file to be saved
  - getNameFromPath
```
public static java.lang.String getNameFromPath(java.lang.String thePath)
```
    Extract file name from a path description.
    
    Parameters:
    
    thePath - the path
    
    Returns:
    
    the extracted file name
  - getDir
```
public static java.lang.String getDir(java.io.File theFile)
```
    Get the directory component of a file.
    
    Parameters:
    
    theFile - the file to get the directory of.
    
    Returns:
    
    the extracted directory path
  - doubleParsable
```
public static double doubleParsable(javax.swing.JTextField tField)
```
    Tests whether the string in a text field is parsable into a double. If so, the double value is returned, if not Double.NaN is returned as a flag that the (double) parsing failed. This method compactly handles exceptions thrown by Double.parseDouble(String), so that try/catch fields do not have to be repeatedly written, and allows the program to continue in the case that the string is not parsable.
    
    Parameters:
    
    tField - The text field to read from and test if its text can be parsed into a double value
    
    Returns:
    
    Either the double value of the String in the text field, if it can be parsed, or NaN, as a flag, if it cannot be.
  - doubleParsable
```
public static double doubleParsable(java.lang.String text)
```
    Like doubleParsable(JTextField) but checks for the formatting of a string rather than a text field.
    
    Parameters:
    
    text - the text to check
    
    Returns:
    
    NaN if invalid, the parsed double otherwise
  - parseInteger
```
public static java.lang.Integer parseInteger(javax.swing.JTextField tField)
```
    Parses the given String in the text field into an integer. If given a double value, double_val parsing will not fail, but rather, the result of (int) double_val will be returned. Returns a null Integer in cases where the string cannot be parsed into an instance of Number or if something else went wrong. Parsing is done using the default locale of the JVM being used to run Simbrain.
    
    Parameters:
    
    tField - the text field containing the String to be parsed.
    
    Returns:
    
    the integer value of the string or null if the String cannot be parsed into a Number
  - parseInteger
```
public static java.lang.Integer parseInteger(java.lang.String text)
```
    The same as parseInteger(JTextField) except using a String directly as an input.
    
    Parameters:
    
    text -
    
    Returns:
  - getVectorString
```
public static java.lang.String getVectorString(double[] theVec,
                                               java.lang.String delimiter)
```
    Convert an array of doubles into a String.
    
    Parameters:
    
    theVec - the array of doubles to convert
    
    delimiter - Delimiter
    
    Returns:
    
    the String representation of the array
  - getVectorString
```
public static double[] getVectorString(java.lang.String theVec,
                                       java.lang.String delimiter)
```
    Convert a delimited string of doubles into an array of doubles. Undoes String getVectorString.
    
    Parameters:
    
    theVec - string version of vector
    
    delimiter - delimiter used in that string
    
    Returns:
    
    the corresponding array of doubles
  - stringArrayToDoubleArray
```
public static double[] stringArrayToDoubleArray(java.lang.String[] line)
```
    Converts an array of strings containing doubles into an array of doubles.
    
    Parameters:
    
    line - the array of strings
    
    Returns:
    
    the array of doubles
  - doubleArrayToStringArray
```
public static java.lang.String[] doubleArrayToStringArray(double[] line)
```
    Converts an array of doubles into an array of Strings of those doubles.
    
    Parameters:
    
    line - the array of doubles
    
    Returns:
    
    the array of strings
  - doubleMatrixToStringMatrix
```
public static java.lang.String[][] doubleMatrixToStringMatrix(double[][] matrix)
```
    Converts a matrix of doubles into a matrix of Strings representing those doubles. Used with writeMatrix.
    
    Parameters:
    
    matrix - the matrix of doubles
    
    Returns:
    
    the matrix of Strings
  - doubleArrayToString
```
public static java.lang.String doubleArrayToString(double[] data)
```
    Utility to class to convert arrays of doubles to strings.
    
    Parameters:
    
    data - array of doubles
    
    Returns:
    
    string representation of that array
  - parseVectorString
```
public static double[] parseVectorString(java.lang.String vectorString)
```
    Converts a String representation of a vector (e.g. "1,0,0,1,0") into a double array. Invalid characters are converted to 0.
    
    Parameters:
    
    vectorString - the string to parse.
    
    Returns:
    
    the parsed double array.
  - round
```
public static java.lang.String round(double num,
                                     int precision)
```
    Returns a string rounded to the desired precision.
    
    Parameters:
    
    num - double to convert
    
    precision - number of decimal places
    
    Returns:
    
    string representation of rounded decimal
  - showHelpPage
```
public static void showHelpPage(java.lang.String helpPage)
```
    Display a documentation page under {simbrainhome}/docs/...
    
    Parameters:
    
    helpPage - Help page
  - displayLocalHtmlInBrowser
```
public static void displayLocalHtmlInBrowser(java.lang.String url)
```
    Launch an .html page using the system's default browser.
    
    Parameters:
    
    url - the url to display. Assumes it is in the local file system.
  - floatToHue
```
public static java.awt.Color floatToHue(float fclr)
```
    Converts a floating point value into a color in HSB, with Saturation and Brightness 1.
    
    Parameters:
    
    fclr - Float color
    
    Returns:
    
    Hue, saturation, and brightness
  - colorToFloat
```
public static float colorToFloat(java.awt.Color clr)
```
    Returns the Hue associated with a Color.
    
    Parameters:
    
    clr - Color
    
    Returns:
    
    Hue, saturation and brightness
  - setAlpha
```
public static int setAlpha(int alpha,
                           int rgbIntColor)
```
    Sets the alpha of the color represented by rgBInt to the value specified in alpha and returns the resulting color.
    
    Parameters:
    
    alpha - an opacity value on [0, 255]
    
    rgbIntColor - an integer representing a color where bits 0-7 are blue, 8-15 are green, 16-23 are red, and 24-31 are alpha
    
    Returns:
    
    the color expressed as an integer with the specified alpha and all other bits the same.
  - setRed
```
public static int setRed(int red,
                         int rgbIntColor)
```
    Sets the red value of the color represented by rgbIntColor to the value specified by red and returns the resulting color.
    
    Parameters:
    
    red - a red value on [0, 255]
    
    rgbIntColor - an integer representing a color where bits 0-7 are blue, 8-15 are green, 16-23 are red, and 24-31 are alpha
    
    Returns:
    
    the color expressed as an integer with the specified red and all other bits the same.
  - setGreen
```
public static int setGreen(int green,
                           int rgbIntColor)
```
    Sets the green value of the color represented by rgbIntColor to the value specified by green and returns the resulting color.
    
    Parameters:
    
    green - a green value on [0, 255]
    
    rgbIntColor - an integer representing a color where bits 0-7 are blue, 8-15 are green, 16-23 are red, and 24-31 are alpha
    
    Returns:
    
    the color expressed as an integer with the specified green and all other bits the same.
  - setBlue
```
public static int setBlue(int blue,
                          int rgbIntColor)
```
    Sets the blue value of the color represented by rgbIntColor to the value specified by blue and returns the resulting color.
    
    Parameters:
    
    blue - a blue value on [0, 255]
    
    rgbIntColor - an integer representing a color where bits 0-7 are blue, 8-15 are green, 16-23 are red, and 24-31 are alpha
    
    Returns:
    
    the color expressed as an integer with the specified blue and all other bits the same.
  - doubleMatrixToString
```
public static java.lang.String doubleMatrixToString(double[][] matrix)
```
    Convert a 2-d array of doubles to a string.
    
    Parameters:
    
    matrix - the matrix to print
    
    Returns:
    
    the formatted string
  - getOSMatches
```
static boolean getOSMatches(java.lang.String osNamePrefix)
```
    Decides if the operating system matches.
    Source adapted from org.apache.commons.lang.SystemUtils
    
    Parameters:
    
    osNamePrefix - the prefix for the os name
    
    Returns:
    
    true if matches, or false if not or can't determine
  - isMacOSX
```
public static boolean isMacOSX()
```
    Determines whether the system is a Mac os x.
    
    Returns:
    
    whether the system is a Mac os x.
  - select
```
public static java.util.Collection select(java.util.Collection selection,
                                          Predicate filter)
```
    Reimplementation of same method from org.apache.commons.collections.CollectionUtils.
    
    Parameters:
    
    selection - the collection to filter
    
    filter - the predicate to be used in filtering.
    
    Returns:
    
    those members of the selection to which the predicate applies
  - union
```
public static java.util.Collection union(java.util.Collection a,
                                         java.util.Collection b)
```
    Re-implementation of same method from org.apache.commons.collections.CollectionUtils.
    
    Parameters:
    
    a - Collection
    
    b - Collection
    
    Returns:
    
    union of two collections
  - intersection
```
public static java.util.Collection intersection(java.util.Collection a,
                                                java.util.Collection b)
```
    Re-implementation of same method from org.apache.commons.collections.CollectionUtils.
    
    Parameters:
    
    a - Collection
    
    b - Collection
    
    Returns:
    
    intersection of two collections
  - getSimbrainProperties
```
public static java.util.Properties getSimbrainProperties()
```
    Return the Simbrain properties file, or null if it is not found.
    
    Returns:
    
    the Simbrain properties file
  - readFileContents
```
public static java.lang.String readFileContents(java.io.File file)
```
    Returns the contents of a file as a String.
    
    Parameters:
    
    file - the file to read
    
    Returns:
    
    the string contents of the file
  - concatenate
```
public static <T> T[] concatenate(T[] A,
                                  T[] B)
```
    Concatenate two arrays A, B to produce a third array A + B. From Jean Nicolas https://chocolatapp.com/
    
    Type Parameters:
    
    T - type of the arrays to concatenate
    
    Parameters:
    
    A - first array
    
    B - second array
    
    Returns:
    
    A + B array consisting of first followed by second.
  - intersects
```
public static <T> boolean intersects(java.util.Collection<T> A,
                                     java.util.Collection<T> B)
```
    True if collection A has a non-empty intersection with collection B, false otherwise.
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    A - first collection
    
    B - second collection
    
    Returns:
    
    A intersects B

Class Utils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Utils

Method Detail

getTimeString

getDoubleMatrix

getStringMatrix

writeMatrix

writeMatrix

getRelativePath

getNameFromPath

getDir

doubleParsable

doubleParsable

parseInteger

parseInteger

getVectorString

getVectorString

stringArrayToDoubleArray

doubleArrayToStringArray

doubleMatrixToStringMatrix

doubleArrayToString

parseVectorString

round

showHelpPage

displayLocalHtmlInBrowser

floatToHue

colorToFloat

setAlpha

setRed

setGreen

setBlue

doubleMatrixToString

getOSMatches

isMacOSX

select

union

intersection

getSimbrainProperties

readFileContents

concatenate

intersects