io.scif.services

Interface LuraWaveService

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.Optional, org.scijava.Prioritized, org.scijava.plugin.RichPlugin, SCIFIOService, org.scijava.plugin.SciJavaPlugin, org.scijava.service.Service, org.scijava.Versioned

public interface LuraWaveService
extends SCIFIOService, org.scijava.Optional

Author:

Chris Allan

Field Summary

Fields

Modifier and Type	Field and Description
static String	INVALID_LICENSE_MSG Message to display if an invalid LuraWave license code is given.
static String	LICENSE_PROPERTY System property to check for the LuraWave license code.
static String	NO_LICENSE_MSG Message to display if no LuraWave license code is given.
static String	NO_LURAWAVE_MSG Message displayed if the LuraWave LWF decoder library is not found.
static String	STUB_FIELD Identifying field in stub class.

Method Summary

Modifier and Type	Method and Description
void	decodeToMemoryGray16(short[] image, int imageoffset, int limit, int quality, int scale, int pdx, int pdy, int clip_x, int clip_y, int clip_w, int clip_h) Wraps com.luratech.lwf.lwfDecoder#decodeToMemoryGray16(short[], int, int, int, int, int, int, int, int, int, int) .
void	decodeToMemoryGray8(byte[] image, int limit, int quality, int scale) Wraps com.luratech.lwf.lwfDecoder#decodeToMemoryGray8(byte[], int, int, int) .
int	getHeight() Wraps com.luratech.lwf.lwfDecoder#getHeight()
String	getLicenseCode() Retrieves the current license code as a string.
int	getWidth() Wraps com.luratech.lwf.lwfDecoder#getWidth()
void	initialize(InputStream stream) Wraps com.luratech.lwf.lwfDecoder#lwfDecoder(InputStream, String, String) .
void	setLicenseCode(String license) Overrides the license code to use when initializing the LuraWave decoder.

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

Field Detail

LICENSE_PROPERTY

static final String LICENSE_PROPERTY

System property to check for the LuraWave license code.

See Also:

Constant Field Values

NO_LURAWAVE_MSG

static final String NO_LURAWAVE_MSG

Message displayed if the LuraWave LWF decoder library is not found.

See Also:

Constant Field Values

NO_LICENSE_MSG

static final String NO_LICENSE_MSG

Message to display if no LuraWave license code is given.

See Also:

Constant Field Values

INVALID_LICENSE_MSG

static final String INVALID_LICENSE_MSG

Message to display if an invalid LuraWave license code is given.

See Also:

Constant Field Values

STUB_FIELD

static final String STUB_FIELD

Identifying field in stub class.

See Also:

Constant Field Values

Method Detail

setLicenseCode

void setLicenseCode(String license)

Overrides the license code to use when initializing the LuraWave decoder. By default the license code is loaded from the "lurawave.license" system property.

Parameters:

license - String license code.

getLicenseCode

String getLicenseCode()

Retrieves the current license code as a string.

Returns:

See above.

initialize

void initialize(InputStream stream)
         throws IOException,
                DependencyException,
                ServiceException

Wraps com.luratech.lwf.lwfDecoder#lwfDecoder(InputStream, String, String) .

Throws:

IOException - If parsing of the image header fails.

DependencyException - If no license code was specified.

ServiceException - If the license code is invalid.

getWidth

int getWidth()

Wraps com.luratech.lwf.lwfDecoder#getWidth()

getHeight

int getHeight()

Wraps com.luratech.lwf.lwfDecoder#getHeight()

decodeToMemoryGray8

void decodeToMemoryGray8(byte[] image,
                         int limit,
                         int quality,
                         int scale)
                  throws ServiceException

Wraps com.luratech.lwf.lwfDecoder#decodeToMemoryGray8(byte[], int, int, int) .

Throws:

ServiceException - If the license code is invalid.

decodeToMemoryGray16

void decodeToMemoryGray16(short[] image,
                          int imageoffset,
                          int limit,
                          int quality,
                          int scale,
                          int pdx,
                          int pdy,
                          int clip_x,
                          int clip_y,
                          int clip_w,
                          int clip_h)
                   throws ServiceException

Wraps com.luratech.lwf.lwfDecoder#decodeToMemoryGray16(short[], int, int, int, int, int, int, int, int, int, int) .

Throws:

ServiceException - If the license code is invalid.