Module io.scif

Package io.scif.services

Interface DatasetIOService

All Superinterfaces:

Comparable<org.scijava.Prioritized>, org.scijava.Contextual, org.scijava.Disposable, org.scijava.plugin.HasPluginInfo, org.scijava.Identifiable, org.scijava.Initializable, org.scijava.Locatable, org.scijava.log.Logged, org.scijava.Prioritized, org.scijava.plugin.RichPlugin, SCIFIOService, org.scijava.plugin.SciJavaPlugin, org.scijava.service.Service, org.scijava.Versioned

All Known Implementing Classes:

DefaultDatasetIOService

public interface DatasetIOService
extends SCIFIOService

A service for opening and saving Datasets using SCIFIO.

Author:

Mark Hiner

Method Summary

Modifier and Type	Method	Description
boolean	canOpen(String source)	Determines whether the given source can be opened as a Dataset using the open(Location) method.
boolean	canOpen(org.scijava.io.location.Location source)	Determines whether the given source can be opened as a Dataset using the open(Location) method.
boolean	canSave(org.scijava.io.location.Location destination)	Determines whether the given destination can be used to save a Dataset using the save(Dataset, Location) method.
net.imagej.Dataset	open(String source)
net.imagej.Dataset	open(String source, SCIFIOConfig config)	Loads a dataset from a source (such as a file on disk).
net.imagej.Dataset	open(org.scijava.io.location.Location source)	Loads a dataset from a source (such as a file on disk).
net.imagej.Dataset	open(org.scijava.io.location.Location source, SCIFIOConfig config)	As open(Location), with the given io.scif.config.SCIFIOConfig.
List<net.imagej.Dataset>	openAll(String source)
List<net.imagej.Dataset>	openAll(String source, SCIFIOConfig config)
List<net.imagej.Dataset>	openAll(org.scijava.io.location.Location source)	Load all the datasets from a given source.
List<net.imagej.Dataset>	openAll(org.scijava.io.location.Location source, SCIFIOConfig config)	As openAll(Location), with a given io.scif.config.SCIFIOConfig.
Metadata	save(net.imagej.Dataset dataset, String destination)	Saves a dataset to a destination (such as a file on disk).
Metadata	save(net.imagej.Dataset dataset, String destination, SCIFIOConfig config)	Saves a dataset to a destination (such as a file on disk).
Metadata	save(net.imagej.Dataset dataset, org.scijava.io.location.Location destination)	Saves a dataset to a destination (such as a file on disk).
Metadata	save(net.imagej.Dataset dataset, org.scijava.io.location.Location destination, SCIFIOConfig config)	Saves a dataset to a destination (such as a file on disk).

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Disposable

dispose

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.service.Service

initialize, registerEventHandlers

Methods inherited from interface org.scijava.Versioned

getVersion

Method Detail

canOpen

boolean canOpen(org.scijava.io.location.Location source)

Determines whether the given source can be opened as a Dataset using the open(Location) method.

canOpen

boolean canOpen(String source)

Determines whether the given source can be opened as a Dataset using the open(Location) method.

canSave

boolean canSave(org.scijava.io.location.Location destination)

Determines whether the given destination can be used to save a Dataset using the save(Dataset, Location) method.

open

net.imagej.Dataset open(org.scijava.io.location.Location source)
                 throws IOException

Loads a dataset from a source (such as a file on disk).

Throws:

IOException

open

net.imagej.Dataset open(String source)
                 throws IOException

Throws:

IOException

See Also:

open(Location)

open

net.imagej.Dataset open(org.scijava.io.location.Location source,
                        SCIFIOConfig config)
                 throws IOException

As open(Location), with the given io.scif.config.SCIFIOConfig.

Throws:

IOException

open

net.imagej.Dataset open(String source,
                        SCIFIOConfig config)
                 throws IOException

Loads a dataset from a source (such as a file on disk).

Throws:

IOException

openAll

List<net.imagej.Dataset> openAll(org.scijava.io.location.Location source)
                          throws IOException

Load all the datasets from a given source. (Useful for files containing image series)

Parameters:

source - the source location of the images

Returns:

a list of all datasets contained by the image file.

Throws:

IOException

openAll

List<net.imagej.Dataset> openAll(String source)
                          throws IOException

Throws:

IOException

See Also:

openAll(Location)

openAll

List<net.imagej.Dataset> openAll(org.scijava.io.location.Location source,
                                 SCIFIOConfig config)
                          throws IOException

As openAll(Location), with a given io.scif.config.SCIFIOConfig.

Parameters:

source - path on the disk

config - SCIFIOConfig file

Returns:

a list of all datasets contained by the image file.

Throws:

IOException

openAll

List<net.imagej.Dataset> openAll(String source,
                                 SCIFIOConfig config)
                          throws IOException

Throws:

IOException

See Also:

openAll(Location)

save

Metadata save(net.imagej.Dataset dataset,
              org.scijava.io.location.Location destination)
       throws IOException

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

Metadata save(net.imagej.Dataset dataset,
              org.scijava.io.location.Location destination,
              SCIFIOConfig config)
       throws IOException

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

save

Metadata save(net.imagej.Dataset dataset,
              String destination,
              SCIFIOConfig config)
       throws IOException

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

save

Metadata save(net.imagej.Dataset dataset,
              String destination)
       throws IOException

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