DatasetService (ImageJ2 Javadocs 0-SNAPSHOT API)

All Superinterfaces:

Comparable<Prioritized>, Contextual, Disposable, HasPluginInfo, Identifiable, ImageJService, Initializable, Locatable, Logged, Prioritized, RichPlugin, SciJavaPlugin, Service, Versioned

All Known Implementing Classes:

DefaultDatasetService
```
public interface DatasetService
extends ImageJService
```
Interface for service that works with Datasets.

Author:

Curtis Rueden, Mark Hiner

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`canOpen(String source)` Deprecated. Use io.scif.services.DatasetIOService#canOpen instead.
`boolean`	`canSave(String destination)` Deprecated. Use io.scif.services.DatasetIOService#canSave instead.
`<T extends RealType<T>> Dataset`	`create(ImgFactory<T> factory, long[] dims, String name, AxisType[] axes)` Creates a new dataset using the provided `ImgFactory`.
`<T extends RealType<T>> Dataset`	`create(ImgFactory<T> factory, T type, long[] dims, String name, AxisType[] axes)` Deprecated. Use `create(ImgFactory, long[], String, AxisType[])` instead.
`<T extends Type<T>> Dataset`	`create(ImgPlus<T> imgPlus)` Creates a new dataset using the provided `ImgPlus`.
`Dataset`	`create(long[] dims, String name, AxisType[] axes, int bitsPerPixel, boolean signed, boolean floating)` Creates a new dataset.
`Dataset`	`create(long[] dims, String name, AxisType[] axes, int bitsPerPixel, boolean signed, boolean floating, boolean virtual)` Creates a new dataset.
`<T extends Type<T>> Dataset`	`create(RandomAccessibleInterval<T> rai)` Creates a new dataset using the provided `RandomAccessibleInterval`.
`<T extends RealType<T> & NativeType<T>> Dataset`	`create(T type, long[] dims, String name, AxisType[] axes)` Creates a new dataset.
`<T extends RealType<T> & NativeType<T>> Dataset`	`create(T type, long[] dims, String name, AxisType[] axes, boolean virtual)` Creates a new dataset.
`List<Dataset>`	`getDatasets()` Gets a list of all `Dataset`s.
`List<Dataset>`	`getDatasets(ImageDisplay display)` Gets a list of `Dataset`s linked to the given `ImageDisplay`.
`ObjectService`	`getObjectService()`
`Dataset`	`open(String source)` Deprecated. Use io.scif.services.DatasetIOService#open instead.
`Dataset`	`open(String source, Object config)` Deprecated. Use io.scif.services.DatasetIOService#open instead.
`void`	`revert(Dataset dataset)` Deprecated. Use io.scif.services.DatasetIOService#revert instead.
`Object`	`save(Dataset dataset, String destination)` Deprecated. Use io.scif.services.DatasetIOService#save instead.
`Object`	`save(Dataset dataset, String destination, Object config)` Deprecated. Use io.scif.services.DatasetIOService#save instead.

Methods inherited from interface org.scijava.service.Service
initialize, registerEventHandlers

Methods inherited from interface org.scijava.plugin.RichPlugin
getIdentifier, log

Methods inherited from interface org.scijava.Contextual
context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized
compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo
getInfo, setInfo

Methods inherited from interface org.scijava.Locatable
getLocation

Methods inherited from interface org.scijava.Versioned
getVersion

Methods inherited from interface org.scijava.Disposable
dispose

- Method Detail
  - getObjectService
```
ObjectService getObjectService()
```
  - getDatasets
```
List<Dataset> getDatasets()
```
    Gets a list of all Datasets. This method is a shortcut that delegates to ObjectService.
  - getDatasets
```
List<Dataset> getDatasets(ImageDisplay display)
```
    Gets a list of Datasets linked to the given ImageDisplay.
  - create
```
Dataset create(long[] dims,
               String name,
               AxisType[] axes,
               int bitsPerPixel,
               boolean signed,
               boolean floating)
```
    Creates a new dataset.
    
    Parameters:
    
    dims - The dataset's dimensional extents.
    
    name - The dataset's name.
    
    axes - The dataset's dimensional axis labels.
    
    bitsPerPixel - The dataset's bit depth. Currently supported bit depths include 1, 8, 12, 16, 32 and 64.
    
    signed - Whether the dataset's pixels can have negative values.
    
    floating - Whether the dataset's pixels can have non-integer values.
    
    Returns:
    
    The newly created dataset.
    
    Throws:
    
    IllegalArgumentException - If the combination of bitsPerPixel, signed and floating parameters do not form a valid data type.
  - create
```
Dataset create(long[] dims,
               String name,
               AxisType[] axes,
               int bitsPerPixel,
               boolean signed,
               boolean floating,
               boolean virtual)
```
    Creates a new dataset.
    
    Parameters:
    
    dims - The dataset's dimensional extents.
    
    name - The dataset's name.
    
    axes - The dataset's dimensional axis labels.
    
    bitsPerPixel - The dataset's bit depth. Currently supported bit depths include 1, 8, 12, 16, 32 and 64.
    
    signed - Whether the dataset's pixels can have negative values.
    
    floating - Whether the dataset's pixels can have non-integer values.
    
    virtual - Whether to store in a virtual data structure or not.
    
    Returns:
    
    The newly created dataset.
    
    Throws:
    
    IllegalArgumentException - If the combination of bitsPerPixel, signed and floating parameters do not form a valid data type.
  - create
```
<T extends RealType<T> & NativeType<T>> Dataset create(T type,
                                                       long[] dims,
                                                       String name,
                                                       AxisType[] axes)
```
    Creates a new dataset.
    
    Type Parameters:
    
    T - The type of the dataset.
    
    Parameters:
    
    type - The type of the dataset.
    
    dims - The dataset's dimensional extents.
    
    name - The dataset's name.
    
    axes - The dataset's dimensional axis labels.
    
    Returns:
    
    The newly created dataset.
  - create
```
<T extends RealType<T> & NativeType<T>> Dataset create(T type,
                                                       long[] dims,
                                                       String name,
                                                       AxisType[] axes,
                                                       boolean virtual)
```
    Creates a new dataset.
    
    Type Parameters:
    
    T - The type of the dataset.
    
    Parameters:
    
    type - The type of the dataset.
    
    dims - The dataset's dimensional extents.
    
    name - The dataset's name.
    
    axes - The dataset's dimensional axis labels.
    
    virtual - If true make a virtual dataset.
    
    Returns:
    
    The newly created dataset.
  - create
```
<T extends RealType<T>> Dataset create(ImgFactory<T> factory,
                                       long[] dims,
                                       String name,
                                       AxisType[] axes)
```
    Creates a new dataset using the provided ImgFactory.
    
    Type Parameters:
    
    T - The type of the dataset.
    
    Parameters:
    
    factory - The ImgFactory to use to create the data.
    
    dims - The dataset's dimensional extents.
    
    name - The dataset's name.
    
    axes - The dataset's dimensional axis labels.
    
    Returns:
    
    The newly created dataset.
  - create
```
<T extends Type<T>> Dataset create(ImgPlus<T> imgPlus)
```
    Creates a new dataset using the provided ImgPlus.
    
    Parameters:
    
    imgPlus - The ImgPlus backing the dataset.
    
    Returns:
    
    The newly created dataset.
  - create
```
<T extends Type<T>> Dataset create(RandomAccessibleInterval<T> rai)
```
    Creates a new dataset using the provided RandomAccessibleInterval.
    
    Parameters:
    
    rai - The RandomAccessibleInterval, which will be wrapped into an ImgPlus that will back the new dataset.
    
    Returns:
    
    The newly created dataset.
  - canOpen
```
@Deprecated
boolean canOpen(String source)
```
    Deprecated. Use io.scif.services.DatasetIOService#canOpen instead.
    
    Determines whether the given source can be opened as a Dataset using the open(String) method.
  - canSave
```
@Deprecated
boolean canSave(String destination)
```
    Deprecated. Use io.scif.services.DatasetIOService#canSave instead.
    
    Determines whether the given destination can be used to save a Dataset using the save(Dataset, String) method.
  - open
```
@Deprecated
Dataset open(String source)
                  throws IOException
```
    Deprecated. Use io.scif.services.DatasetIOService#open instead.
    
    Loads a dataset from a source (such as a file on disk).
    
    Throws:
    
    IOException
  - open
```
@Deprecated
Dataset open(String source,
                         Object config)
                  throws IOException
```
    Deprecated. Use io.scif.services.DatasetIOService#open instead.
    
    As open(String), with the given io.scif.config.SCIFIOConfig.
    
    Throws:
    
    IOException
  - revert
```
@Deprecated
void revert(Dataset dataset)
                 throws IOException
```
    Deprecated. Use io.scif.services.DatasetIOService#revert instead.
    
    Reverts the given dataset to its original source.
    
    Throws:
    
    IOException
  - save
```
@Deprecated
Object save(Dataset dataset,
                        String destination)
                 throws IOException
```
    Deprecated. Use io.scif.services.DatasetIOService#save instead.
    
    Saves a dataset to a destination (such as a file on disk).
    
    Parameters:
    
    dataset - The dataset to save.
    
    destination - Where the dataset should be saved (e.g., a file path on disk).
    
    Throws:
    
    IOException
  - save
```
@Deprecated
Object save(Dataset dataset,
                        String destination,
                        Object config)
                 throws IOException
```
    Deprecated. Use io.scif.services.DatasetIOService#save instead.
    
    Saves a dataset to a destination (such as a file on disk).
    
    Parameters:
    
    dataset - The dataset to save.
    
    destination - Where the dataset should be saved (e.g., a file path on disk).
    
    config - The io.scif.config.SCIFIOConfig describing how the data should be saved.
    
    Throws:
    
    IOException
  - create
```
@Deprecated
<T extends RealType<T>> Dataset create(ImgFactory<T> factory,
                                                   T type,
                                                   long[] dims,
                                                   String name,
                                                   AxisType[] axes)
```
    Deprecated. Use create(ImgFactory, long[], String, AxisType[]) instead.

Interface DatasetService

Method Summary

Methods inherited from interface org.scijava.service.Service

Methods inherited from interface org.scijava.plugin.RichPlugin

Methods inherited from interface org.scijava.Contextual

Methods inherited from interface org.scijava.Prioritized

Methods inherited from interface org.scijava.plugin.HasPluginInfo

Methods inherited from interface org.scijava.Locatable

Methods inherited from interface org.scijava.Versioned

Methods inherited from interface org.scijava.Disposable

Method Detail

getObjectService

getDatasets

getDatasets

create

create

create

create

create

create

create

canOpen

canSave

open

open

revert

save

save

create