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

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

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

    Subinterfaces of ILazyDataset 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.
    `interface` | `IDataset` This interface defines the implementation-independent and generic parts of a dataset.
    `interface` | `IDynamicDataset` This interface is intended for data sources that change dynamically.
    `interface` | `ILazyWriteableDataset` This sub-interface adds the ability to write to a lazy dataset slice-by-slice

    Classes in org.eclipse.january.dataset that implement ILazyDataset
    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` | `AggregateDataset` Class to aggregate a set of lazy datasets and present them as a single lazy dataset where the first position value accesses the aggregation
    `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` | `LazyDataset`
    `class` | `LazyDatasetBase` Common base for both lazy and normal dataset implementations
    `class` | `LazyDynamicDataset`
    `class` | `LazyWriteableDataset` Subclass of lazy dataset that allows setting slices
    `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 ILazyDataset
    Modifier and Type | Method and Description
    --- | ---
    `ILazyDataset` | ILazyDataset.`clone()` Clone dataset
    `protected ILazyDataset` | LazyDatasetBase.`createFromSerializable(Serializable blob, boolean keepLazy)`
    `ILazyDataset` | IDynamicShape.`getDataset()`
    `ILazyDataset` | LazyDynamicDataset.`getDataset()`
    `ILazyDataset` | AggregateDataset.`getErrors()`
    `ILazyDataset` | ILazyDataset.`getErrors()` Get the errors, if any.
    `ILazyDataset` | LazyDatasetBase.`getErrors()`
    `ILazyDataset` | ILazyDataset.`getSliceView(int[] start, int[] stop, int[] step)` Get a slice of the dataset.
    `ILazyDataset` | ILazyDataset.`getSliceView(Slice... slice)` Get a slice of the dataset.
    `ILazyDataset` | ILazyDataset.`getSliceView(SliceND slice)` Get a slice of the dataset.
    `ILazyDataset` | ILazyDataset.`getTransposedView(int... axes)` Permute copy of dataset's axes so that given order is old order:
    `static ILazyDataset` | Random.`lazyRand(int... shape)`
    `static ILazyDataset` | Random.`lazyRand(int dtype, String name, int... shape)` Deprecated. Use `Random.lazyRand(String, Class, int...)`
    `static ILazyDataset` | Random.`lazyRand(String name, Class<? extends Dataset> clazz, int... shape)`
    `static ILazyDataset` | Random.`lazyRand(String name, int... shape)`
    `ILazyDataset` | AggregateDataset.`squeezeEnds()`
    `ILazyDataset` | ILazyDataset.`squeezeEnds()` Remove dimensions of 1 from ends of shape of the dataset

    Methods in org.eclipse.january.dataset with parameters of type ILazyDataset
    Modifier and Type | Method and Description
    --- | ---
    `static int[][]` | AggregateDataset.`calcShapes(boolean extend, ILazyDataset... datasets)` Calculate (possibly extended) shapes from given datasets
    `void` | AbstractDataset.`checkCompatibility(ILazyDataset g)`
    `void` | Dataset.`checkCompatibility(ILazyDataset g)` This method takes a dataset and checks its shape against the current dataset.
    `static void` | ShapeUtils.`checkCompatibility(ILazyDataset g, ILazyDataset h)` This function takes a dataset and checks its shape against another dataset.
    `static SliceND` | SliceND.`createSlice(ILazyDataset data, int[] start, int[] stop)` Creats SliceND from dataset.
    `static SliceND` | SliceND.`createSlice(ILazyDataset data, int[] start, int[] stop, int[] step)` Creating SliceND from dataset.
    `static String` | DTypeUtils.`getDatasetName(ILazyDataset a)`
    `static int` | DTypeUtils.`getDType(ILazyDataset d)` Get dataset type from given dataset
    `static String` | DTypeUtils.`getDTypeName(ILazyDataset a)`
    `static int` | LazyDataset.`getMaxSliceLength(ILazyDataset lazySet, int dimension)` Gets the maximum size of a slice of a dataset in a given dimension which should normally fit in memory.
    `protected static ConcurrentMap<Class<? extends MetadataType>,List<MetadataType>>` | LazyDatasetBase.`getMetadataMap(ILazyDataset a, boolean clone)`
    `boolean` | AbstractDataset.`isCompatibleWith(ILazyDataset g)`
    `boolean` | Dataset.`isCompatibleWith(ILazyDataset g)` This method takes a dataset and checks its shape against the current dataset.
    `static boolean` | InterfaceUtils.`isElemental(ILazyDataset a)`
    `static boolean` | InterfaceUtils.`isFloating(ILazyDataset a)`
    `static boolean` | InterfaceUtils.`isInteger(ILazyDataset a)`
    `static Dataset` | LazyMaths.`max(ILazyDataset data, int... axes)`
    `static Dataset` | LazyMaths.`mean(ILazyDataset data, int... ignoreAxes)`
    `static Dataset` | LazyMaths.`mean(int start, int stop, ILazyDataset data, int... ignoreAxes)`
    `static Dataset` | LazyMaths.`min(ILazyDataset data, int... axes)`
    `static Dataset` | LazyMaths.`product(ILazyDataset data, int axis)`
    `void` | IDatasetChangeChecker.`setDataset(ILazyDataset dataset)` Set dataset to be checked for signs of change.
    `void` | ShapeChangeChecker.`setDataset(ILazyDataset dataset)`
    `static void` | DatasetUtils.`setShapeToOriginalRank(ILazyDataset a, int[] originalShape, int... axes)` Set shape to keep original rank
    `static Dataset` | DatasetUtils.`sliceAndConvertLazyDataset(ILazyDataset lazy)` Slice (or fully load), if necessary, a lazy dataset, otherwise take a slice view and convert to our dataset implementation.
    `static Dataset` | LazyMaths.`sum(ILazyDataset data, boolean ignore, int... axes)`
    `static Dataset` | LazyMaths.`sum(ILazyDataset data, int... ignoreAxes)`
    `static Dataset` | LazyMaths.`sum(ILazyDataset data, int axis)`

    Constructors in org.eclipse.january.dataset with parameters of type ILazyDataset
    Constructor and Description
    `AggregateDataset(boolean extend, ILazyDataset... datasets)` Create an aggregate dataset

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

    Methods in org.eclipse.january.metadata that return ILazyDataset
    Modifier and Type | Method and Description
    --- | ---
    `ILazyDataset` | ARPESMetadata.`getAnalyserAngles()`
    `ILazyDataset[]` | AxesMetadata.`getAxes()` Get axis datasets
    `ILazyDataset[]` | AxesMetadata.`getAxis(int axisDim)` Get all axis datasets for the given dimension
    `ILazyDataset` | ARPESMetadata.`getAzimuthalAngles()`
    `ILazyDataset` | ARPESMetadata.`getBindingEnergies()`
    `ILazyDataset` | ARPESMetadata.`getEnergyAxisOffset()`
    `ILazyDataset` | ErrorMetadata.`getError()` Get error dataset
    `ILazyDataset` | ARPESMetadata.`getKineticEnergies()`
    `ILazyDataset` | OriginMetadata.`getParent()`
    `ILazyDataset` | ARPESMetadata.`getPhotoelectronMomentum()`
    `ILazyDataset` | ARPESMetadata.`getPolarAngles()`
    `ILazyDataset` | ARPESMetadata.`getTiltAngles()`

    Methods in org.eclipse.january.metadata with parameters of type ILazyDataset
    Modifier and Type | Method and Description
    --- | ---
    `void` | AxesMetadata.`addAxis(int axisDim, ILazyDataset axisData)` Add axis data to given dimension.
    `void` | AxesMetadata.`addAxis(int primaryAxisDim, ILazyDataset axisData, int... dimMapping)` Add axis data to given dimension.
    `void` | ErrorMetadata.`initialize(ILazyDataset error)`
    `void` | OriginMetadata.`initialize(ILazyDataset parent, Slice[] outSlice, int[] dataDims, String filePath, String datasetName)` Initialize origin of dataset
    `void` | AxesMetadata.`setAxis(int axisDim, ILazyDataset... axisData)` Set axis datasets for given dimension.
    `void` | ErrorMetadata.`setError(ILazyDataset error)` Set the error

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