io.scif.services

Class DefaultInitializeService

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

org.scijava.service.AbstractService

io.scif.services.DefaultInitializeService

All Implemented Interfaces:

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

public class DefaultInitializeService
extends org.scijava.service.AbstractService
implements InitializeService

Default InitializeService implementation.

Author:

Mark Hiner

See Also:

InitializeService

Constructor Summary

Constructors

Constructor and Description
DefaultInitializeService()

Method Summary

Modifier and Type	Method and Description
ReaderFilter	initializeReader(org.scijava.io.location.Location id) See InitializeService.initializeReader(Location, SCIFIOConfig).
ReaderFilter	initializeReader(org.scijava.io.location.Location id, SCIFIOConfig config) Convenience method for creating a Reader component that is ready to open planes of the provided image source.
Writer	initializeWriter(org.scijava.io.location.Location source, org.scijava.io.location.Location destination) See InitializeService.initializeWriter(Location, Location, SCIFIOConfig).
Writer	initializeWriter(org.scijava.io.location.Location source, org.scijava.io.location.Location destination, SCIFIOConfig config) As InitializeService.initializeWriter(Location, Location) with configuration options.
Writer	initializeWriter(Metadata sourceMeta, org.scijava.io.location.Location destination) See InitializeService.initializeWriter(Location, Location, SCIFIOConfig).
Writer	initializeWriter(Metadata sourceMeta, org.scijava.io.location.Location destination, SCIFIOConfig config) As InitializeService.initializeWriter(Metadata, Location) with configuration options.
Metadata	parseMetadata(org.scijava.io.location.Location id) Convenience method to parse Metadata without reading the underlying pixels.
Metadata	parseMetadata(org.scijava.io.location.Location id, SCIFIOConfig config) As InitializeService.parseMetadata(Location) with a flag to open the underlying dataset when parsing, if desired.

Methods inherited from class org.scijava.service.AbstractService

getContext, setContext, toString

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority

Methods inherited from class org.scijava.AbstractContextual

context

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Constructor Detail

DefaultInitializeService

public DefaultInitializeService()

Method Detail

initializeReader

public ReaderFilter initializeReader(org.scijava.io.location.Location id)
                              throws FormatException,
                                     IOException

Description copied from interface: InitializeService

See InitializeService.initializeReader(Location, SCIFIOConfig). Will not open the image source while parsing metadata.

Specified by:

initializeReader in interface InitializeService

Parameters:

id - Name of the image source to be read.

Returns:

An initialized Reader.

Throws:

FormatException

IOException

initializeReader

public ReaderFilter initializeReader(org.scijava.io.location.Location id,
                                     SCIFIOConfig config)
                              throws FormatException,
                                     IOException

Description copied from interface: InitializeService

Convenience method for creating a Reader component that is ready to open planes of the provided image source. The reader's Metadata and source fields will be populated.

Specified by:

initializeReader in interface InitializeService

Parameters:

id - Name of the image source to be read.

config - Configuration for this method execution.

Returns:

An initialized Reader.

Throws:

FormatException

IOException

initializeWriter

public Writer initializeWriter(org.scijava.io.location.Location source,
                               org.scijava.io.location.Location destination)
                        throws FormatException,
                               IOException

Description copied from interface: InitializeService

See InitializeService.initializeWriter(Location, Location, SCIFIOConfig). Will not open the image source while parsing metadata.

Specified by:

initializeWriter in interface InitializeService

Parameters:

source - Name of the image source to use for parsing metadata.

destination - Name of the writing destination.

Returns:

An initialized Writer.

Throws:

FormatException

IOException

initializeWriter

public Writer initializeWriter(org.scijava.io.location.Location source,
                               org.scijava.io.location.Location destination,
                               SCIFIOConfig config)
                        throws FormatException,
                               IOException

Description copied from interface: InitializeService

As InitializeService.initializeWriter(Location, Location) with configuration options.

Specified by:

initializeWriter in interface InitializeService

Parameters:

source - Name of the image source to use for parsing metadata.

destination - Name of the writing destination.

config - Configuration for this method execution.

Returns:

An initialized Writer.

Throws:

FormatException

IOException

initializeWriter

public Writer initializeWriter(Metadata sourceMeta,
                               org.scijava.io.location.Location destination)
                        throws FormatException,
                               IOException

Description copied from interface: InitializeService

See InitializeService.initializeWriter(Location, Location, SCIFIOConfig). Will not open the image source while parsing metadata.

Specified by:

initializeWriter in interface InitializeService

Parameters:

sourceMeta - Name of the image source to use for parsing metadata.

destination - Name of the writing destination.

Returns:

An initialized Writer.

Throws:

FormatException

IOException

initializeWriter

public Writer initializeWriter(Metadata sourceMeta,
                               org.scijava.io.location.Location destination,
                               SCIFIOConfig config)
                        throws FormatException,
                               IOException

Description copied from interface: InitializeService

As InitializeService.initializeWriter(Metadata, Location) with configuration options.

Specified by:

initializeWriter in interface InitializeService

Parameters:

sourceMeta - Name of the image source to use for parsing metadata.

destination - Name of the writing destination.

config - Configuration information to use for this parse.

Returns:

An initialized Writer.

Throws:

FormatException

IOException

parseMetadata

public Metadata parseMetadata(org.scijava.io.location.Location id)
                       throws IOException,
                              FormatException

Description copied from interface: InitializeService

Convenience method to parse Metadata without reading the underlying pixels. Useful when translating to other formats, or simply extracting image metadata. Will not open the image source when determining format compatibility.

Specified by:

parseMetadata in interface InitializeService

Parameters:

id - Name of the image source to be read.

Returns:

Parsed Metadata for the given source.

Throws:

IOException

FormatException

parseMetadata

public Metadata parseMetadata(org.scijava.io.location.Location id,
                              SCIFIOConfig config)
                       throws FormatException,
                              IOException

Description copied from interface: InitializeService

As InitializeService.parseMetadata(Location) with a flag to open the underlying dataset when parsing, if desired.

Specified by:

parseMetadata in interface InitializeService

Parameters:

id - Name of the image source to be read.

config - Configuration for this method execution.

Returns:

Parsed Metadata for the given source.

Throws:

FormatException

IOException