org.g_node.nix.util

Class DataAccess

java.lang.Object

org.g_node.nix.util.DataAccess

@Platform(include={"<nix/util/dataAccess.hpp>","<nix/Block.hpp>","<nix/DataArray.hpp>","<nix/Dimensions.hpp>","<nix/Feature.hpp>","<nix/File.hpp>","<nix/MultiTag.hpp>","<nix/Property.hpp>","<nix/Section.hpp>","<nix/Source.hpp>","<nix/Tag.hpp>"}) @Platform(value="linux",link="nix@.1",preload="hdf5@.7") @Platform(value="windows",link="nix",preload={"hdf5","msvcp120","msvcr120","szip","zlib"})
 @Namespace(value="nix::util")
public class DataAccess
extends Object

DataAccess

This class contains utility functions.

Constructor Summary

Constructors

Constructor and Description
DataAccess()

Method Summary

Modifier and Type	Method and Description
static void	getOffsetAndCount(MultiTag tag, DataArray array, long index, NDSize offsets, NDSize counts) Returns the offsets and element counts associated with position and extent of a Tag and the referenced DataArray.
static void	getOffsetAndCount(Tag tag, DataArray array, NDSize offsets, NDSize counts) Returns the offsets and element counts associated with position and extent of a Tag and the referenced DataArray.
static boolean	positionAndExtentInData(DataArray data, NDSize position, NDSize count) Checks whether a given position plus count is in the extent of the given DataArray.
static boolean	positionInData(DataArray data, NDSize position) Checks whether a given position is in the extent of the given DataArray.
static long	positionToIndex(double position, String unit, RangeDimension dimension) Converts a position given in a unit into an index according to the dimension descriptor.
static long	positionToIndex(double position, String unit, SampledDimension dimension) Converts a position given in a unit into an index according to the dimension descriptor.
static long	positionToIndex(double position, String unit, SetDimension dimension) Converts a position given in a unit into an index according to the dimension descriptor.
static DataView	retrieveData(MultiTag tag, long positionIndex, long referenceIndex) Retrieve the data referenced by the given position and extent of the MultiTag.
static DataView	retrieveData(Tag tag, long referenceIndex) Retrieve the data referenced by the given position and extent of the Tag.
static DataView	retrieveFeatureData(MultiTag tag, long positionIndex) Returns the feature data accosiated with the given MuliTag's position.
static DataView	retrieveFeatureData(MultiTag tag, long positionIndex, long featureIndex) Returns the feature data accosiated with the given MuliTag's position.
static DataView	retrieveFeatureData(Tag tag) Retruns the feature data associated with a Tag.
static DataView	retrieveFeatureData(Tag tag, long featureIndex) Retruns the feature data associated with a Tag.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataAccess

public DataAccess()

Method Detail

positionToIndex

public static long positionToIndex(double position,
                                   @StdString
                                   String unit,
                                   @Const @ByRef
                                   SetDimension dimension)

Converts a position given in a unit into an index according to the dimension descriptor.

This function can be used to get the index of e.g. a certain point in time in a Dimension that represents time. The units of the position and that provided by the Dimension must match, i.e. must be scalable versions of the same SI unit.

Parameters:

position - The position

unit - The unit in which the position is given, may be "none"

dimension - The dimension descriptor for the respective dimension.

Returns:

The calculated index.

See Also:

SetDimension

positionToIndex

public static long positionToIndex(double position,
                                   @StdString
                                   String unit,
                                   @Const @ByRef
                                   SampledDimension dimension)

Converts a position given in a unit into an index according to the dimension descriptor.

This function can be used to get the index of e.g. a certain point in time in a Dimension that represents time. The units of the position and that provided by the Dimension must match, i.e. must be scalable versions of the same SI unit.

Parameters:

position - The position

unit - The unit in which the position is given, may be "none"

dimension - The dimension descriptor for the respective dimension.

Returns:

The calculated index.

See Also:

SampledDimension

positionToIndex

public static long positionToIndex(double position,
                                   @StdString
                                   String unit,
                                   @Const @ByRef
                                   RangeDimension dimension)

Converts a position given in a unit into an index according to the dimension descriptor.

This function can be used to get the index of e.g. a certain point in time in a Dimension that represents time. The units of the position and that provided by the Dimension must match, i.e. must be scalable versions of the same SI unit.

Parameters:

position - The position

unit - The unit in which the position is given, may be "none"

dimension - The dimension descriptor for the respective dimension.

Returns:

The calculated index.

See Also:

RangeDimension

getOffsetAndCount

public static void getOffsetAndCount(@Const @ByRef
                                     Tag tag,
                                     @Const @ByRef
                                     DataArray array,
                                     @ByRef
                                     NDSize offsets,
                                     @ByRef
                                     NDSize counts)

Returns the offsets and element counts associated with position and extent of a Tag and the referenced DataArray.

Parameters:

tag - The tag.

array - A referenced data array.

offsets - The resulting offset.

counts - The number of elements to read from data

See Also:

DataArray, NDSize, Tag

getOffsetAndCount

public static void getOffsetAndCount(@Const @ByRef
                                     MultiTag tag,
                                     @Const @ByRef
                                     DataArray array,
                                     @Cast(value="size_t")
                                     long index,
                                     @ByRef
                                     NDSize offsets,
                                     @ByRef
                                     NDSize counts)

Returns the offsets and element counts associated with position and extent of a Tag and the referenced DataArray.

Parameters:

tag - The tag.

array - A referenced data array.

index - index.

offsets - The resulting offset.

counts - The number of elements to read from data

See Also:

DataArray, MultiTag, NDSize

retrieveData

@ByVal
public static DataView retrieveData(@Const @ByRef
                                           MultiTag tag,
                                           @Cast(value="size_t")
                                           long positionIndex,
                                           @Cast(value="size_t")
                                           long referenceIndex)

Retrieve the data referenced by the given position and extent of the MultiTag.

Parameters:

tag - The multi tag.

positionIndex - The index of the position.

referenceIndex - The index of the reference from which data should be returned.

Returns:

The data referenced by position and extent.

See Also:

DataView, MultiTag

retrieveData

@ByVal
public static DataView retrieveData(@Const @ByRef
                                           Tag tag,
                                           @Cast(value="size_t")
                                           long referenceIndex)

Retrieve the data referenced by the given position and extent of the Tag.

Parameters:

tag - The multi tag.

referenceIndex - The index of the reference from which data should be returned.

Returns:

The data referenced by the position.

See Also:

DataView, Tag

positionInData

public static boolean positionInData(@Const @ByRef
                                     DataArray data,
                                     @Const @ByRef
                                     NDSize position)

Checks whether a given position is in the extent of the given DataArray.

Parameters:

data - The data array.

position - The position.

Returns:

True if the position is in the extent of the data array, false otherwise.

See Also:

DataArray, NDSize

positionAndExtentInData

public static boolean positionAndExtentInData(@Const @ByRef
                                              DataArray data,
                                              @Const @ByRef
                                              NDSize position,
                                              @Const @ByRef
                                              NDSize count)

Checks whether a given position plus count is in the extent of the given DataArray.

Parameters:

data - The DataArray.

position - The position

count - The number of elements per dimension.

Returns:

True if position and count are in the extent of the data array, false otherwise.

See Also:

DataArray, NDSize

retrieveFeatureData

@ByVal
public static DataView retrieveFeatureData(@Const @ByRef
                                                  Tag tag,
                                                  @Cast(value="size_t")
                                                  long featureIndex)

Retruns the feature data associated with a Tag.

Parameters:

tag - The Tag whos feature data is requested

featureIndex - The index of the desired feature. Default is 0.

Returns:

The associated data.

See Also:

DataView, Tag

retrieveFeatureData

@ByVal
public static DataView retrieveFeatureData(@Const @ByRef
                                                  Tag tag)

Retruns the feature data associated with a Tag. Feature Index defaulted to 0.

Parameters:

tag - The Tag whos feature data is requested

Returns:

The associated data.

See Also:

DataView, Tag

retrieveFeatureData

@ByVal
public static DataView retrieveFeatureData(@Const @ByRef
                                                  MultiTag tag,
                                                  @Cast(value="size_t")
                                                  long positionIndex,
                                                  @Cast(value="size_t")
                                                  long featureIndex)

Returns the feature data accosiated with the given MuliTag's position.

Parameters:

tag - The MultiTag whos feature data is requested.

positionIndex - The index of the selected position, respectively the selected tag of the MultiTag.

featureIndex - The index of the desired feature.

Returns:

The associated data.

See Also:

DataView, MultiTag

retrieveFeatureData

@ByVal
public static DataView retrieveFeatureData(@Const @ByRef
                                                  MultiTag tag,
                                                  @Cast(value="size_t")
                                                  long positionIndex)

Returns the feature data accosiated with the given MuliTag's position. Feature Index defaulted to 0.

Parameters:

tag - The MultiTag whos feature data is requested.

positionIndex - The index of the selected position, respectively the selected tag of the MultiTag.

Returns:

The associated data.

See Also:

DataView, MultiTag