## Uses of Interface
org.eclipse.january.dataset.IDataset

- Packages that use IDataset
  Package | Description
  --- | ---
  org.eclipse.january.dataset |
  org.eclipse.january.io |
  org.eclipse.january.metadata |

- - ### Uses of IDataset in org.eclipse.january.dataset

    Subinterfaces of IDataset in org.eclipse.january.dataset
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `CompoundDataset`
    `interface` | `Dataset` Interface for our implementation of dataset that adds a lot of extra functionality.
    `interface` | `DateDataset` Interface for a dataset containing `Date`s.

    Classes in org.eclipse.january.dataset that implement IDataset
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractCompoundDataset` Generic container class for data that is compound in nature Each subclass has an array of compound types, items of this array are composed of primitive types Data items can be Complex, Vector, etc
    `class` | `AbstractDataset` Generic container class for data
    `class` | `BooleanDataset` Extend boolean base dataset for boolean values
    `class` | `BooleanDatasetBase` Extend dataset for boolean values // PRIM_TYPE
    `class` | `ByteDataset` Extend dataset for byte values // PRIM_TYPE
    `class` | `ComplexDoubleDataset` Extend compound dataset to hold complex double values // PRIM_TYPE
    `class` | `ComplexFloatDataset` Extend compound dataset to hold complex float values // PRIM_TYPE
    `class` | `CompoundByteDataset` Extend compound dataset for byte values // PRIM_TYPE
    `class` | `CompoundDoubleDataset` Extend compound dataset for double values // PRIM_TYPE
    `class` | `CompoundFloatDataset` Extend compound dataset for float values // PRIM_TYPE
    `class` | `CompoundIntegerDataset` Extend compound dataset for int values // PRIM_TYPE
    `class` | `CompoundLongDataset` Extend compound dataset for long values // PRIM_TYPE
    `class` | `CompoundShortDataset` Extend compound dataset for short values // PRIM_TYPE
    `class` | `DateDatasetImpl`
    `class` | `DoubleDataset` Extend dataset for double values // PRIM_TYPE
    `class` | `FloatDataset` Extend dataset for float values // PRIM_TYPE
    `class` | `IntegerDataset` Extend dataset for int values // PRIM_TYPE
    `class` | `LongDataset` Extend dataset for long values // PRIM_TYPE
    `class` | `ObjectDataset` Extend dataset for objects
    `class` | `ObjectDatasetBase` Extend dataset for Object values // PRIM_TYPE
    `class` | `RGBByteDataset` Class to hold colour datasets as red, green, blue tuples of byte integers.
    `class` | `RGBDataset` Class to hold colour datasets as red, green, blue tuples of short integers
    `class` | `ShortDataset` Extend dataset for short values // PRIM_TYPE
    `class` | `StringDataset` Extend dataset for objects
    `class` | `StringDatasetBase` Extend dataset for String values // PRIM_TYPE

    Methods in org.eclipse.january.dataset that return IDataset
    Modifier and Type | Method and Description
    --- | ---
    `IDataset` | IDataset.`clone()` Clone dataset, making new copy of data
    `IDataset` | IDataset.`getErrors()`
    `IDataset` | ILazyDataset.`getSlice(IMonitor monitor, int[] start, int[] stop, int[] step)` Get a slice of the dataset.
    `IDataset` | ILazyDataset.`getSlice(IMonitor monitor, Slice... slice)` Get a slice of the dataset.
    `IDataset` | ILazyDataset.`getSlice(IMonitor monitor, SliceND slice)` Get a slice of the dataset.
    `IDataset` | IDataset.`getSlice(int[] start, int[] stop, int[] step)`
    `IDataset` | ILazyDataset.`getSlice(int[] start, int[] stop, int[] step)` Get a slice of the dataset.
    `IDataset` | IDataset.`getSlice(Slice... slice)`
    `IDataset` | ILazyDataset.`getSlice(Slice... slice)` Get a slice of the dataset.
    `IDataset` | IDataset.`getSlice(SliceND slice)`
    `IDataset` | ILazyDataset.`getSlice(SliceND slice)` Get a slice of the dataset.
    `IDataset` | IDataset.`getSliceView(int[] start, int[] stop, int[] step)` Get a slice of the dataset.
    `IDataset` | IDataset.`getSliceView(Slice... slice)` Get a slice of the dataset.
    `IDataset` | IDataset.`getSliceView(SliceND slice)` Get a slice of the dataset.
    `IDataset` | IDataset.`getTransposedView(int... axes)` Permute copy of dataset's axes so that given order is old order:
    `IDataset` | IDataset.`squeeze()` Remove dimensions of 1 in shape of the dataset
    `IDataset` | IDataset.`squeeze(boolean onlyFromEnds)` Remove dimensions of 1 in shape of the dataset from ends only if true
    `IDataset` | IDataset.`squeezeEnds()`

    Methods in org.eclipse.january.dataset with parameters of type IDataset
    Modifier and Type | Method and Description
    --- | ---
    `static BooleanDataset` | Comparisons.`allTrue(IDataset a, int axis)` Test if all items along given axis are true in the input dataset
    `static BooleanDataset` | Comparisons.`anyTrue(IDataset a, int axis)` Test if any items along given axis are true in the input dataset
    `static Dataset` | DatasetUtils.`append(IDataset a, IDataset b, int axis)` Append copy of dataset with another dataset along n-th axis
    `static <T extends Dataset> T` | DatasetUtils.`cast(Class<T> clazz, IDataset d)` Cast a dataset
    `static Dataset` | DatasetUtils.`cast(IDataset d, boolean repeat, int dtype, int isize)` Deprecated. Please use the class-based methods in DatasetUtils, such as `DatasetUtils.cast(Class, IDataset)`
    `static Dataset` | DatasetUtils.`cast(IDataset d, int dtype)` Deprecated. Please use the class-based methods in DatasetUtils, such as `DatasetUtils.cast(Class, IDataset)`
    `static <T extends Dataset> T` | DatasetUtils.`cast(int isize, Class<T> clazz, IDataset d, boolean repeat)` Cast a dataset
    `static Dataset` | DatasetUtils.`concatenate(IDataset[] as, int axis)` Concatenate the set of datasets along given axis
    `static Dataset` | DatasetUtils.`convertToDataset(IDataset data)` Convert (if necessary) a dataset obeying the interface to our implementation
    `static <T extends Dataset> T` | DatasetUtils.`copy(Class<T> clazz, IDataset d)` Cast a dataset
    `static Dataset` | DatasetUtils.`copy(IDataset d, int dtype)` Deprecated. Please use the class-based methods in DatasetUtils, such as `DatasetUtils.copy(Class, IDataset)`
    `static Dataset` | DatasetUtils.`extract(IDataset data, IDataset condition)` Extract values where condition is non-zero.
    `static double` | Maths.`getBilinear(IDataset d, double x0, double x1)` Deprecated. Use `Maths.interpolate(Dataset, double, double)`
    `static double` | Maths.`getBilinear(IDataset d, IDataset m, double x0, double x1)` Deprecated. Use `Maths.interpolate(Dataset, Dataset, double, double)`
    `static double` | Maths.`getLinear(IDataset d, double x0)` Deprecated. Use `Maths.interpolate(Dataset, double)`
    `static Dataset` | Maths.`interpolate(Dataset x, Dataset d, IDataset x0, Number left, Number right)` Linearly interpolate values at points in a 1D dataset corresponding to given coordinates.
    `static Dataset` | DatasetUtils.`makeUnsigned(IDataset a)` Make a dataset unsigned by promoting it to a wider dataset type and unwrapping the signs of its contents
    `static Dataset` | DatasetUtils.`makeUnsigned(IDataset a, boolean check)` Make a dataset unsigned by promoting it to a wider dataset type and unwrapping the signs of its contents
    `static Serializable` | DatasetUtils.`serializeDataset(IDataset data)` Serialize dataset by flattening it.
    `void` | LazyWriteableDataset.`setSlice(IDataset data, SliceND slice)` Set a slice of the dataset
    `void` | ILazyWriteableDataset.`setSlice(IMonitor monitor, IDataset data, int[] start, int[] stop, int[] step)` Set a slice of the dataset
    `void` | LazyWriteableDataset.`setSlice(IMonitor monitor, IDataset data, int[] start, int[] stop, int[] step)`
    `void` | ILazyWriteableDataset.`setSlice(IMonitor monitor, IDataset data, SliceND slice)` Set a slice of the dataset
    `void` | LazyWriteableDataset.`setSlice(IMonitor monitor, IDataset data, SliceND slice)`
    `void` | ILazyWriteableDataset.`setSliceSync(IMonitor monitor, IDataset data, SliceND slice)` Set a slice of the dataset synchronously
    `void` | LazyWriteableDataset.`setSliceSync(IMonitor monitor, IDataset data, SliceND slice)`
    `static Dataset` | DatasetUtils.`swapAxes(IDataset a, int axis1, int axis2)` Swap two axes in dataset
    `static Dataset` | DatasetUtils.`tile(IDataset a, int... reps)` Construct a dataset that contains the original dataset repeated the number of times in each axis given by corresponding entries in the reps array
    `static Dataset` | DatasetUtils.`transpose(IDataset a, int... axes)` Permute copy of dataset's axes so that given order is old order:
    `void` | RunningAverage.`update(IDataset dataset)` Update average

    Method parameters in org.eclipse.january.dataset with type arguments of type IDataset
    Modifier and Type | Method and Description
    --- | ---
    `static Dataset` | Maths.`add(Collection<IDataset> sets, boolean requireClone)` Adds all sets passed in together The first IDataset must cast to Dataset For memory efficiency sake if add(...) is called with a set of size one, no clone is done, the original object is returned directly.
    `static Dataset` | CollectionStats.`mean(List<IDataset> sets)` Used to get a mean image from a set of images for instance.
    `static Dataset` | CollectionStats.`median(List<IDataset> sets)` Used to get a median image from a set of images for instance.
    `static Dataset` | Maths.`multiply(Collection<IDataset> sets, boolean requireClone)` Multiplies all sets passed in together The first IDataset must cast to Dataset

    Constructors in org.eclipse.january.dataset with parameters of type IDataset
    Constructor and Description
    `RunningAverage(IDataset dataset)`

  - ### Uses of IDataset in org.eclipse.january.io

    Methods in org.eclipse.january.io that return IDataset
    Modifier and Type | Method and Description
    --- | ---
    `IDataset` | ILazyLoader.`getDataset(IMonitor mon, SliceND slice)`

    Methods in org.eclipse.january.io with parameters of type IDataset
    Modifier and Type | Method and Description
    --- | ---
    `void` | ILazySaver.`setSlice(IMonitor mon, IDataset data, SliceND slice)`
    `void` | ILazyAsyncSaver.`setSliceAsync(IMonitor mon, IDataset data, SliceND slice)` Non-blocking version of `ILazySaver.setSlice(IMonitor, IDataset, SliceND)`

  - ### Uses of IDataset in org.eclipse.january.metadata

    Methods in org.eclipse.january.metadata that return IDataset
    Modifier and Type | Method and Description
    --- | ---
    `IDataset` | MaskMetadata.`getMask()` Get mask

    Methods in org.eclipse.january.metadata with parameters of type IDataset
    Modifier and Type | Method and Description
    --- | ---
    `void` | MaskMetadata.`initialize(IDataset mask)` Initialize mask

Copyright © 2014–2022 Eclipse Foundation. All rights reserved.