Base

class nimble.core.data.Base

The base class for all nimble data objects.

All data types inherit their functionality from this object, then apply their own implementations of its methods (when necessary). Methods in this object apply to the entire object or its elements and its points and features attributes provide addtional methods that apply point-by-point and feature-by-feature, respectively.

Attributes

T

Invert the feature and point indices of the data.

absolutePath

The path to the file this data originated from in absolute form.

dimensions

The true dimensions of this object.

features

An object handling functions manipulating data by features.

logID

Identifier for this object within the log.

name

A name to be displayed when printing or logging this object.

path

The path to the file this data originated from.

points

An object handling functions manipulating data by points.

relativePath

The path to the file this data originated from in relative form.

shape

The number of points and features in the object.

stretch

Extend along a one-dimensional axis to fit another object.

Methods

calculateOnElements(toCalculate[, points, ...])

Apply a calculation to each element.

checkInvariants([level])

Check the integrity of the data.

containsZero()

Evaluate if the object contains one or more zero values.

copy([to, rowsArePoints, outputAs1D])

Duplicate an object.

countElements(condition)

The number of values which satisfy the condition.

countUniqueElements([points, features])

Count of each unique value in the data.

featureView(identifier)

A read-only view of a single feature.

flatten([order, useLog])

Modify this object so that its values are in a single point.

getTypeString()

The nimble Type of this object.

groupByFeature(by[, calculate, ...])

Group data object by one or more features.

hashCode()

Returns a hash for this matrix.

inverse([pseudoInverse])

Compute the inverse or pseudo-inverse of an object.

isApproximatelyEqual(other)

Determine if the data in both objects is likely the same.

isIdentical(other)

Check for equality between two objects.

iterateElements([order, only])

Iterate over each element in this object.

matchingElements(toMatch[, points, ...])

Identify values meeting the provided criteria.

matrixMultiply(other)

Perform matrix multiplication.

matrixPower(power)

Perform matrix power operations on a square matrix.

max()

Returns the maximum value in the nimble object.

mean()

Returns the mean value in the nimble object.

median()

Returns the median value in the nimble object.

medianAbsoluteDeviation()

Returns a number representing the median absolute deviation of the nimble object.

merge(other[, point, feature, onFeature, ...])

Combine data from another object with this object.

min()

Returns the minimum value in the nimble object.

mode()

Returns a number representing the mode of the nimble object.

plotFeatureAgainstFeature(x, y[, ...])

A plot of the pairwise combination of feature values.

plotFeatureAgainstFeatureRollingAverage(x, y)

A rolling average of the pairwise combination of feature values.

plotFeatureDistribution(feature[, outPath, ...])

Plot a histogram of the distribution of values in a feature.

plotFeatureGroupMeans(feature, groupFeature)

Plot the means of a feature grouped by another feature.

plotFeatureGroupStatistics(statistic, ...[, ...])

Plot an aggregate statistic for each group of a feature.

plotHeatMap([includeColorbar, outPath, ...])

Display a plot of the data.

pointView(identifier)

A read-only view of a single point.

proportionMissing()

Returns a number representing the proportion of values that are None or NaN in the nimble object.

proportionZero()

Returns a number representing the proportion of values that are equal to zero in the nimble object.

quartiles()

Returns a list of numbers representing the quartiles of the nimble object.

replaceFeatureWithBinaryFeatures(...[, useLog])

Create binary features for each unique value in a feature.

replaceRectangle(replaceWith, pointStart, ...)

Replace values in the data with other values.

report(*[, useLog])

Report containing information regarding the data in this object.

save(outPath[, fileFormat, includeNames])

Write the data in this object to a file in the specified format.

show([description, points, features, ...])

A printed representation of the data.

solveLinearSystem(b[, solveFunction])

Solves the linear equation A * x = b for unknown x.

sum()

Returns a number representing the sum of the nimble object.

toString([points, features, lineLimit, ...])

A string representation of this object.

trainAndTestSets(testFraction[, labels, ...])

Divide the data into training and testing sets.

transformElements(toTransform[, points, ...])

Modify each element using a function or mapping.

transformFeatureToIntegers(featureToConvert, *)

Represent each unique value in a feature with a unique integer.

transpose(*[, useLog])

Invert the feature and point indices of the data.

unflatten(dataDimensions[, order, useLog])

Adjust a single point or feature to contain multiple points.

uniqueCount()

Returns the number of unique values in the nimble object.

variance()

Returns a number representing the variance of the nimble object.

view([pointStart, pointEnd, featureStart, ...])

Read-only access into the object data.