org.gnode.nix

Class SampledDimension<T extends SampledDimension>

java.lang.Object

org.bytedeco.javacpp.Pointer

org.gnode.nix.base.ImplContainer

org.gnode.nix.SampledDimension<T>

All Implemented Interfaces:

Comparable<T>

@Platform(include="<nix/Dimensions.hpp>",link="nix",preload="hdf5") @Platform(value="linux") @Platform(value="windows")
 @Namespace(value="nix")
public class SampledDimension<T extends SampledDimension>
extends ImplContainer
implements Comparable<T>

SampledDimension

Dimension descriptor for regularly sampled dimensions.

Instances of the SampledDimension Class are used to describe a dimension of data in a DataArray that has been sampled in regular intervals. For example this can be a time axis.

Sampled dimensions are characterized by the label for the dimension, the unit in which the sampling interval is given. If not specified otherwise the dimension starts with zero offset.

Create a sampled dimension

The following example will create a sampled dimension on a data array. The dimension has a sampling rate of 10kHz and represents the time axis of a recording.

 
     DataArray da = ...;
     SampledDimension sd = da.appendSampledDimension(0.1); 

     sd.setUnit("ms");
     sd.setLabel("time");
     sd.setOffset(10000);
 

See Also:

Dimension, RangeDimension, SetDimension

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	compareTo(T dimension)
double[]	getAxis(long count) Returns a list containing the positions defined by this dimension with the start index set to 0.
double[]	getAxis(long count, long startIndex) Returns a list containing the positions defined by this dimension.
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	getOffset() Gets the offset of the dimension.
double	getPositionAt(long index) Returns the position of this dimension at a given index.
double	getSamplingInterval() Gets the sampling interval of the dimension.
String	getUnit() Gets the unit of a dimension.
boolean	isNone() Check if entity is null
void	setLabel(String label) Sets the label of the dimension.
void	setOffset(double offset) Sets the offset of the dimension.
void	setSamplingInterval(double interval) Sets the sampling interval of the dimension.
void	setUnit(String unit) Sets the unit of a dimension.

Methods inherited from class org.gnode.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

SampledDimension

public SampledDimension()

Constructor that creates an uninitialized SampledDimension.

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

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.

See Also:

DataType

getLabel

public String getLabel()

Getter for the label of the dimension.

The label of a SampledDimension 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.

getSamplingInterval

@Name(value="samplingInterval")
public double getSamplingInterval()

Gets the sampling interval of the dimension.

Returns:

The sampling interval.

setSamplingInterval

@Name(value="samplingInterval")
public void setSamplingInterval(double interval)

Sets the sampling interval of the dimension.

Parameters:

interval - The sampling interval to set.

getOffset

public double getOffset()

Gets the offset of the dimension.

The offset defines at which position the sampling was started. The offset is interpreted in the same unit as the sampling interval.

By default the offset is 0.

Returns:

The offset of the SampledDimension.

setOffset

@Name(value="offset")
public void setOffset(double offset)

Sets the offset of the dimension.

Parameters:

offset - The offset of the dimension.

getIndexOf

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

Returns the index of the given position.

This method returns the index of the given position. Use this method for example to find out which data point (index) relates to a given time. Note: This method does not check if the position is within the extent of the data!

Parameters:

position - The position

Returns:

The respective index.

getPositionAt

@Name(value="positionAt")
public double getPositionAt(@Cast(value="const size_t")
                                                      long index)

Returns the position of this dimension at a given index.

This method returns the position at a given index. Use this method for example to find the position that relates to a certain index. Note: This method does not check if the index is the extent of the data!

Parameters:

index - The index.

Returns:

The respective position

getAxis

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

Returns a list containing the positions defined by this dimension.

Parameters:

count - The number of indices

startIndex - The start index

Returns:

array containing the respective dimension.

getAxis

public double[] getAxis(long count)

Returns a list containing the positions defined by this dimension with the start index set to 0.

Parameters:

count - The number of indices

Returns:

array containing the respective dimension.

compareTo

public int compareTo(T dimension)

Specified by:

compareTo in interface Comparable<T extends SampledDimension>