org.g_node.nix

Class RangeDimension<T extends RangeDimension>

java.lang.Object

org.bytedeco.javacpp.Pointer

org.g_node.nix.base.ImplContainer

org.g_node.nix.RangeDimension<T>

All Implemented Interfaces:

Comparable<T>

@Platform(include="<nix/Dimensions.hpp>") @Platform(value="linux",link="nix@.1",preload="hdf5@.7") @Platform(value="windows",link="nix",preload={"hdf5","msvcp120","msvcr120","szip","zlib"})
 @Namespace(value="nix")
public class RangeDimension<T extends RangeDimension>
extends ImplContainer
implements Comparable<T>

RangeDimension

Dimension descriptor for a dimension that is irregularly sampled.

The RangeDimension covers cases when indexes of a dimension are mapped to other values in a not regular fashion. A use-case for this would be for example irregularly sampled time-series or certain kinds of histograms. To achieve the mapping of the indexes an array of mapping values must be provided. Those values are stored in the dimensions setTicks(double[]) property. In analogy to the sampled dimension a setUnit(String) and a setLabel(String) can be defined.

See Also:

Dimension, SampledDimension, SetDimension

Constructor Summary

Constructors

Constructor and Description
RangeDimension() Constructor that creates an uninitialized RangeDimension.

Method Summary

Modifier and Type	Method and Description
int	compareTo(T dimension)
double[]	getAxis(long count) Returns a list containing a number of ticks.
double[]	getAxis(long count, long startIndex) Returns a list containing a number of ticks.
int	getDimensionType() The type of the dimension.
long	getIndex() The actual dimension that is described by the dimension descriptor.
long	getIndexOf(double position) Returns the index of the given position.
String	getLabel() Getter for the label of the dimension.
double	getTickAt(long index) Returns the entry of the range dimension at a given index.
double[]	getTicks() Get the ticks of the dimension.
String	getUnit() Gets the unit of a dimension.
boolean	isAlias() Tells if the RangeDimension uses the contents of a linked DataArray for ticks, i.e. is an alias.
boolean	isNone() Check if entity is null
void	setLabel(String label) Sets the label of the dimension.
void	setTicks(double[] ticks) Set the ticks array for the dimension.
void	setUnit(String unit) Sets the unit of a dimension.

Methods inherited from class org.g_node.nix.base.ImplContainer

isInitialized

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, capacity, capacity, deallocate, deallocate, deallocateReferences, equals, fill, hashCode, isNull, limit, limit, memchr, memcmp, memcpy, memmove, memset, offsetof, position, position, put, setNull, sizeof, toString, zero

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RangeDimension

public RangeDimension()

Constructor that creates an uninitialized RangeDimension.

Calling any method on an uninitialized dimension will throw a RuntimeException.

Method Detail

isNone

@Cast(value="bool")
public boolean isNone()

Description copied from class: ImplContainer

Check if entity is null

Specified by:

isNone in class ImplContainer

Returns:

true if initialized else false

isAlias

@Name(value="alias")
public boolean isAlias()

Tells if the RangeDimension uses the contents of a linked DataArray for ticks, i.e. is an alias.

Returns:

bool true, if RangeDimension is an alias, false otherwise.

getIndex

@Name(value="index")
 @Cast(value="size_t")
public long getIndex()

The actual dimension that is described by the dimension descriptor.

The index of the dimension entity representing the dimension of the actual data that is defined by this descriptor.

Returns:

The dimension index of the dimension.

getDimensionType

@Name(value="dimensionType")
 @ByVal
 @Cast(value="nix::DimensionType")
public int getDimensionType()

The type of the dimension.

This field indicates whether the dimension is a SampledDimension, SetDimension or RangeDimension.

Returns:

The dimension type.

getLabel

public String getLabel()

Getter for the label of the dimension.

The label of a RangeDimension corresponds to the axis label in a plot of the respective dimension.

Returns:

The label of the dimension. Returns null if not present.

setLabel

public void setLabel(String label)

Sets the label of the dimension. If null removes label.

Parameters:

label - The label of the dimension.

getUnit

public String getUnit()

Gets the unit of a dimension.

The unit describes which SI unit applies to this dimension and to its sampling interval.

Returns:

The unit of the dimension.

setUnit

public void setUnit(String unit)

Sets the unit of a dimension. If null removes the unit.

Parameters:

unit - The unit to set.

getTicks

public double[] getTicks()

Get the ticks of the dimension.

The ticks map the index of the data at the respective dimension to other values. This can be used to store data that is sampled at irregular intervals.

Returns:

A list with all ticks for the dimension.

setTicks

@Name(value="ticks")
public void setTicks(@StdVector
                                          double[] ticks)

Set the ticks array for the dimension.

Ticks must be ordered in ascending order.

Parameters:

ticks - The new ticks for the dimension provided as an array.

getTickAt

@Name(value="tickAt")
public double getTickAt(@Cast(value="const size_t")
                                              long index)

Returns the entry of the range dimension at a given index.

Parameters:

index - The index.

Returns:

The tick at the given index.

getIndexOf

@Name(value="indexOf")
 @Cast(value="size_t")
public long getIndexOf(double position)

Returns the index of the given position.

Method will return the index equal or larger than position

Parameters:

position - The position.

Returns:

The respective index.

getAxis

public double[] getAxis(long count,
                        long startIndex)

Returns a list containing a number of ticks.

The result list contains a given number of ticks starting from a starting index

Parameters:

count - The number of ticks.

startIndex - The starting index.

Returns:

array containing the ticks.

getAxis

public double[] getAxis(long count)

Returns a list containing a number of ticks.

The result list contains a given number of ticks starting from a starting index

Parameters:

count - The number of ticks.

Returns:

array containing the ticks.

compareTo

public int compareTo(T dimension)

Specified by:

compareTo in interface Comparable<T extends RangeDimension>