Dimension types
Float: dimension values are floating point type (single or double)
A dimension represents a column in a source dataset. Dimension variables are often passed to shaders to access a particular column of data for a point.
string id
The identifier of the dimension. This is used to retrieve the dimension using the dataset loader. The dimension id is normally interpreted as a table name.
int index
The index of the dimension. This is used to retrieve the dimension used the dataset loader. The dimension index is normally interpreted as the column index in a table.
string label
A descriptive label for the dimension.
Dataset dataset
A pointer variable representing the Dataset instance that the Dimension variable is tied to.
DimensionType type
A Field specifies a subset of a dimension which is limited to a certain domain of data.
Dimension getDimension()
Returns a pointer to the Dimension which the Field is a part of.
bool loaded() Specifies whether the current domain of data is currently in memory. Domains are loaded before the memory is needed for visualization, as opposed to when the dimension is specified.
[Range] range()
Loader is the base class for data loaders
open(string source)
Opens the specified source. Source depends on the specific loader implementation.
extends Loader
An extention of loader used to open simple CSV files.
extends Loader
An extention of loader used to load data from numpy arrays.
addDimension(string name, nparray data)
extends Loader
An extention of loader used to open simple hdf5 format files
extends Loader
Variation of the hdf5loader with support for loading from multi-part files.
extends Loader
Datasets are linked to an HDF5 particle set and assist in accessing data loaded from the respective loading module.
static Dataset create()
Creates a new Dataset object.
setLoader(Loader loader)
Links the Dataset to a file loader, which the dataset will use to pull data from.
addField(Field field)
Adds a field of data that the dataset will attempt to load from using it's respective loader.
addDimension(Dimension dimension)
Defines a Dimension class object, or data source column.
Returns a boolean indicating whether the data loaded through the dataset will be in double precision or single precision.
setDoublePrecision(bool enabled) bool useDoublePrecision()
Sets whether the data loaded through the dataset will use double precision or single precision floating point values.
setField(Field field)
setRange(float min, float max)
setNormalizedRange(float min, float max)
static PlotBrush create()
setFilter(Filter) filter
setColor(Color color)
setEnabled(bool enabled) bool isEnabled()
refresh()
setBlend(bool enabled)
setX(Field x)
Field getX()
setY(Field y)
Field getY()
setSize(int width, int height)
refresh()
PixelData getPixels()
addPointCloud(PointCloud pc)
removePointCloud(PointCloud pc)
resize(int width, int height)
enableColormapper(bool enabled)
setColormapper(Program colormapper)
setColormap(PixelData colormap)
updateChannelBounds(bool useChannelTexture)
setChannelBounds(float channelMin, float channelMax)
float getChannelMin()
float getChannelMax()
PixelData getOutput
extends NodeComponent
A set of scattered points that are drawn when assigned to a Scene Node. Displays the points sent to it from a Dataset.
static PointCloud create()
Creates and returns a new pointCloud object
setOptions(string options)
Sets the Decimation level of the PointCloud. Decimation is used to lower the amount of points loaded for very large data sets, and instead load 1 point for every decimation value. The settings here modify the Loader decimation value. The input is a string should be in the format: "50000 0:100000:X" where X is the decimation level for the loader. The true decimation level is the product of the loader decimation level and the display decimation level. Higher decimation levels result in fewer points being loaded.
Specifies the dimensions that every point loaded will use to determine it's x, y, and z positions when plotted.
setData(Dimension data)
Specifies an additional dimension of data that the pointCloud object will send to the shader, that can be used for custom rendering options.
Used to send three dimensions to the pointCloud's geometry shader. Intended to be used to create
Dimension getDataX() Dimension getDataY() Dimension getDataZ()
Used to retrieve vector data variables.
setSize(Dimension size)
Sends an additional dimension of data to the vertex shader for every point. Intended to be used to specify the vertex's pointSize.
setFilter(Dimension filter)
Specifies the dimension that is used for filtering.
setFilterBounds(float min, float max)
Specifies the bounds of the current PointCloud filter dimension. Objects beyond the filter's dimensions for the current filterDimension will nto be drawn.
normalizeFilterBounds(bool normalize)
Specifies whether the min and max filters are on a normalized or absolute scale. On a normalized scale, 1.0 represents the highest value of the current Dimension in the pointCLoud's data set, while 0.0 represents the lowest value.
setProgram(Program program)
Sets the shader Program that the pointCloud will use. The Program will in turn determine the Vertex, Geometry, and Fragment shaders that will be used when the PointCloud object is drawn.
Program getProgram()
Returns a reference to the current program that the pointCloud is using.
setPointScale(float scale)
Sets the pointScale uniform that is sent to the pointCloud's shaders. Intended to be used when all of the points in a particular pointCloud are intended to have the same size.
setColormap(PixelData colormap)
Sets the colormap object associated with this program.
PixelData getColormap()
setColor(Color color)
Sends a uniform to the pointCloud's shaders intended to represent a uniform color for all shaders.
Color getColor()
Returns the current color.
setDecimation(int decimation)
Sets the dynamic decimation for the pointCloud. When dynamic decimation is set, ony one point for every set of the decimation value is displayed, reducing GPU strain. The dynamic decimation is layered on top of the loader decimation. The true displayed decimation is a product of the two.
setFocusPosition(Vector3 pos)
Passes the parameter 'focusPosition' to the Program Shaders.
setVisible(bool visible)
A collection of shaders which is sent to Signac and used on point data. A program can later be set from a PointCloud, which will make all three shaders associated with the program the active shaders when drawing the particular point cloud.
setVertexShader(string file)
Specifies the Vertex shader associated with this program. Vertex Shaders are called for every point in Signac.
setFragmentShader(string file)
Specifies the fragment shader associated with this program. Fragment shaders will be called for every pixel on the monitor screen and are used when created a 2d texture from the 3d point data.
setGeometryShader(string file)
Specifies the Geometry shader associated with this program. The Geometry shaders take a single primitive point and can treat the point as a more complicated geometric shape. Useful for multiple-layer rendering.
reload()
Forces the shaders to update file sources and defined variables.
define(string definename, string definevalue)
Sets a shader variable of a certain name to a value. The next time a shader is called, it will have the variable of the defined name as the specified value. This can be used to set flags.
clearDefines
Removes all previously defined variables, removing all keys and values.
The base module for Signac.
string Signac getInstance()
Returns an instance of signac
addprogram(Program prog)
Loads a Shader Program into signac, which can later be actived and deactivated dynamically.
setFieldLoadedCommand(string command)
When called from python, sets a python function that is called after signac is finished loading all data for all current datasets.
setWorkerThreads(int threads)
Links Signac to additional worker threads which are used for loading data points from multiple datasets.