ome.services

Class RenderingBean

java.lang.Object

ome.services.RenderingBean

All Implemented Interfaces:

java.io.Serializable, ome.api.ServiceInterface, ome.api.StatefulServiceInterface, omeis.providers.re.RenderingEngine

@Transactional(readOnly=true)
public class RenderingBean
extends java.lang.Object
implements omeis.providers.re.RenderingEngine, java.io.Serializable

Provides the RenderingEngine service. This class is an Adapter to wrap the Renderer so to make it thread-safe.

The multi-threaded design of this component is based on dynamic locking and confinement techniques. All access to the component's internal parts happens through a RenderingEngineImpl object, which is fully synchronized. Internal parts are either never leaked out or given away only if read-only objects. (The only exception are the CodomainMapContext objects which are not read-only but are copied upon every method invocation so to maintain safety.)

Finally the RenderingEngine component doesn't make use of constructs that could compromise liveness.

Since:

3.0-M3

See Also:

RenderingEngine, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	NULL_RENDERER Message if the rendering engine is not ready.

Constructor Summary

Constructors

Constructor and Description
RenderingBean(ome.io.nio.PixelsService dataService, LocalCompress compress, Executor ex, SecuritySystem secSys, omeis.providers.re.lut.LutProvider lutProvider) Compression service Bean injector.

Method Summary

Modifier and Type	Method and Description
void	activate()
void	addCodomainMap(omeis.providers.re.codomain.CodomainMapContext mapCtx) Deprecated.
void	addCodomainMapToChannel(omeis.providers.re.codomain.CodomainMapContext mapCtx, int w) Implemented as specified by the RenderingEngine interface.
void	close()
protected void	errorIfInvalidState()
protected void	errorIfNullPixels() Throws an ApiUsageException if the pixels are not set.
protected void	errorIfNullRenderer() Reloads the rendering engine if null and has been made passive or throws an ApiUsageException if the rendering engine is not set.
protected void	errorIfNullRenderingDef() Throws an ApiUsageException if the rendering settings are not set.
java.util.List	getAvailableFamilies() Implemented as specified by the RenderingEngine interface.
java.util.List	getAvailableModels() Implemented as specified by the RenderingEngine interface.
double	getChannelCurveCoefficient(int w) Implemented as specified by the RenderingEngine interface.
ome.model.enums.Family	getChannelFamily(int w) Implemented as specified by the RenderingEngine interface.
java.lang.String	getChannelLookupTable(int w)
boolean	getChannelNoiseReduction(int w) Implemented as specified by the RenderingEngine interface.
double[]	getChannelStats(int w) Implemented as specified by the RenderingEngine interface.
double	getChannelWindowEnd(int w) Implemented as specified by the RenderingEngine interface.
double	getChannelWindowStart(int w) Implemented as specified by the RenderingEngine interface.
java.util.List<omeis.providers.re.codomain.CodomainMapContext>	getCodomainMapContext(int w) Implemented as specified by the RenderingEngine interface.
float	getCompressionLevel() Implemented as specified by the RenderingEngine interface.
ome.system.EventContext	getCurrentEventContext() Implemented as specified by the RenderingEngine interface.
int	getDefaultT() Implemented as specified by the RenderingEngine interface.
int	getDefaultZ() Implemented as specified by the RenderingEngine interface.
ome.model.enums.RenderingModel	getModel() Implemented as specified by the RenderingEngine interface.
ome.model.core.Pixels	getPixels() Implemented as specified by the RenderingEngine interface.
double	getPixelsTypeLowerBound(int w) Implemented as specified by the RenderingEngine interface.
double	getPixelsTypeUpperBound(int w) Implemented as specified by the RenderingEngine interface.
ome.model.display.QuantumDef	getQuantumDef() Implemented as specified by the RenderingEngine interface.
long	getRenderingDefId()
java.util.List<java.util.List<java.lang.Integer>>	getResolutionDescriptions()
int	getResolutionLevel()
int	getResolutionLevels()
int[]	getRGBA(int w) Implemented as specified by the RenderingEngine interface.
java.lang.Class<? extends ome.api.ServiceInterface>	getServiceInterface() Returns the service corresponding to this class.
int[]	getTileSize()
boolean	isActive(int w) Implemented as specified by the RenderingEngine interface.
boolean	isPixelsTypeSigned() Implemented as specified by the RenderingEngine interface.
void	load() Implemented as specified by the RenderingEngine interface.
void	loadRenderingDef(long renderingDefId) Implemented as specified by the RenderingEngine interface.
void	lookupPixels(long pixelsId) Implemented as specified by the RenderingEngine interface.
boolean	lookupRenderingDef(long pixelsId) Implemented as specified by the RenderingEngine interface.
void	passivate()
void	removeCodomainMap(omeis.providers.re.codomain.CodomainMapContext mapCtx) Deprecated.
void	removeCodomainMapFromChannel(omeis.providers.re.codomain.CodomainMapContext mapCtx, int w) Implemented as specified by the RenderingEngine interface.
omeis.providers.re.RGBBuffer	render(omeis.providers.re.data.PlaneDef pd) Implemented as specified by the RenderingEngine interface.
int[]	renderAsPackedInt(omeis.providers.re.data.PlaneDef pd) Implemented as specified by the RenderingEngine interface.
byte[]	renderCompressed(omeis.providers.re.data.PlaneDef pd) Implemented as specified by the RenderingEngine interface.
int[]	renderProjectedAsPackedInt(int algorithm, int timepoint, int stepping, int start, int end) Implemented as specified by the RenderingEngine interface.
byte[]	renderProjectedCompressed(int algorithm, int timepoint, int stepping, int start, int end) Implemented as specified by the RenderingEngine interface.
boolean	requiresPixelsPyramid()
long	resetDefaultSettings(boolean save) Implemented as specified by the RenderingEngine interface.
long	saveAsNewSettings() Implemented as specified by the RenderingEngine interface.
void	saveCurrentSettings() Implemented as specified by the RenderingEngine interface.
void	setActive(int w, boolean active) Implemented as specified by the RenderingEngine interface.
void	setChannelLookupTable(int w, java.lang.String lookup)
void	setChannelWindow(int w, double start, double end) Implemented as specified by the RenderingEngine interface.
void	setCodomainInterval(int start, int end) Implemented as specified by the RenderingEngine interface.
void	setCompressionLevel(float percentage) Implemented as specified by the RenderingEngine interface.
void	setDefaultT(int t) Implemented as specified by the RenderingEngine interface.
void	setDefaultZ(int z) Implemented as specified by the RenderingEngine interface.
void	setModel(ome.model.enums.RenderingModel model) Implemented as specified by the RenderingEngine interface.
void	setOverlays(java.util.Map<byte[],java.lang.Integer> overlays) Deprecated. As of release 5.1.0, replaced by PlaneDef.setShapeIds(List).
void	setQuantizationMap(int w, ome.model.enums.Family family, double coefficient, boolean noiseReduction) Implemented as specified by the RenderingEngine interface.
void	setQuantumStrategy(int bitResolution) Implemented as specified by the RenderingEngine interface.
void	setResolutionLevel(int resolutionLevel)
void	setRGBA(int w, int red, int green, int blue, int alpha) Implemented as specified by the RenderingEngine interface.
void	updateCodomainMap(omeis.providers.re.codomain.CodomainMapContext mapCtx) Deprecated.
void	updateSettings(ome.model.display.RenderingDef settings) Implemented as specified by the RenderingEngine interface.

Methods inherited from class java.lang.Object

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

Field Detail

NULL_RENDERER

protected static final java.lang.String NULL_RENDERER

Message if the rendering engine is not ready.

See Also:

Constant Field Values

Constructor Detail

RenderingBean

public RenderingBean(ome.io.nio.PixelsService dataService,
                     LocalCompress compress,
                     Executor ex,
                     SecuritySystem secSys,
                     omeis.providers.re.lut.LutProvider lutProvider)

Compression service Bean injector.

Parameters:

dataService - The pixels service

compress - an ICompress.

ex - Reference to the executor.

secSys - Reference to the security system.

lutProvider - Reference to the lookup table provider.

Method Detail

getServiceInterface

public java.lang.Class<? extends ome.api.ServiceInterface> getServiceInterface()

Returns the service corresponding to this class.

Returns:

See above.

getRenderingDefId

public long getRenderingDefId()

Specified by:

getRenderingDefId in interface omeis.providers.re.RenderingEngine

passivate

@Transactional(readOnly=true)
public void passivate()

Specified by:

passivate in interface ome.api.StatefulServiceInterface

activate

@Transactional(readOnly=true)
public void activate()

Specified by:

activate in interface ome.api.StatefulServiceInterface

close

public void close()

Specified by:

close in interface ome.api.StatefulServiceInterface

lookupPixels

public void lookupPixels(long pixelsId)

Implemented as specified by the RenderingEngine interface.

Specified by:

lookupPixels in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.lookupPixels(long)

lookupRenderingDef

public boolean lookupRenderingDef(long pixelsId)

Implemented as specified by the RenderingEngine interface.

Specified by:

lookupRenderingDef in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.lookupRenderingDef(long)

loadRenderingDef

public void loadRenderingDef(long renderingDefId)

Implemented as specified by the RenderingEngine interface.

Specified by:

loadRenderingDef in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.loadRenderingDef(long)

load

public void load()

Implemented as specified by the RenderingEngine interface.

Specified by:

load in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.load()

setOverlays

public void setOverlays(java.util.Map<byte[],java.lang.Integer> overlays)

Deprecated. As of release 5.1.0, replaced by PlaneDef.setShapeIds(List).

Implemented as specified by the RenderingEngine interface.

Specified by:

setOverlays in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.setOverlays(Map)

getCurrentEventContext

public ome.system.EventContext getCurrentEventContext()

Implemented as specified by the RenderingEngine interface.

Specified by:

getCurrentEventContext in interface ome.api.StatefulServiceInterface

See Also:

StatefulServiceInterface.getCurrentEventContext()

render

public omeis.providers.re.RGBBuffer render(omeis.providers.re.data.PlaneDef pd)

Implemented as specified by the RenderingEngine interface.

Specified by:

render in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.render(PlaneDef)

renderAsPackedInt

public int[] renderAsPackedInt(omeis.providers.re.data.PlaneDef pd)

Implemented as specified by the RenderingEngine interface.

Specified by:

renderAsPackedInt in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.render(PlaneDef)

renderCompressed

public byte[] renderCompressed(omeis.providers.re.data.PlaneDef pd)

Implemented as specified by the RenderingEngine interface.

Specified by:

renderCompressed in interface omeis.providers.re.RenderingEngine

See Also:

LocalCompress.compressToStream(BufferedImage, java.io.OutputStream)

renderProjectedAsPackedInt

public int[] renderProjectedAsPackedInt(int algorithm,
                                        int timepoint,
                                        int stepping,
                                        int start,
                                        int end)

Implemented as specified by the RenderingEngine interface.

Specified by:

renderProjectedAsPackedInt in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.renderAsPackedInt(PlaneDef)

renderProjectedCompressed

public byte[] renderProjectedCompressed(int algorithm,
                                        int timepoint,
                                        int stepping,
                                        int start,
                                        int end)

Implemented as specified by the RenderingEngine interface.

Specified by:

renderProjectedCompressed in interface omeis.providers.re.RenderingEngine

See Also:

LocalCompress.compressToStream(BufferedImage, java.io.OutputStream)

resetDefaultSettings

public long resetDefaultSettings(boolean save)

Implemented as specified by the RenderingEngine interface.

Specified by:

resetDefaultSettings in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.resetDefaultSettings(boolean)

setCompressionLevel

public void setCompressionLevel(float percentage)

Implemented as specified by the RenderingEngine interface.

Specified by:

setCompressionLevel in interface omeis.providers.re.RenderingEngine

See Also:

LocalCompress.setCompressionLevel(float)

getCompressionLevel

public float getCompressionLevel()

Implemented as specified by the RenderingEngine interface.

Specified by:

getCompressionLevel in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.getCompressionLevel()

saveAsNewSettings

@Transactional(readOnly=false)
public long saveAsNewSettings()

Implemented as specified by the RenderingEngine interface.

Specified by:

saveAsNewSettings in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.saveAsNewSettings()

updateSettings

public void updateSettings(ome.model.display.RenderingDef settings)

Implemented as specified by the RenderingEngine interface.

Specified by:

updateSettings in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.updateSettings(RenderingDef)

saveCurrentSettings

@Transactional(readOnly=false)
public void saveCurrentSettings()

Implemented as specified by the RenderingEngine interface.

Specified by:

saveCurrentSettings in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.saveCurrentSettings()

getChannelCurveCoefficient

public double getChannelCurveCoefficient(int w)

Implemented as specified by the RenderingEngine interface.

Specified by:

getChannelCurveCoefficient in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.getChannelCurveCoefficient(int)

getChannelFamily

public ome.model.enums.Family getChannelFamily(int w)

Implemented as specified by the RenderingEngine interface.

Specified by:

getChannelFamily in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.getChannelFamily(int)

getChannelNoiseReduction

public boolean getChannelNoiseReduction(int w)

Implemented as specified by the RenderingEngine interface.

Specified by:

getChannelNoiseReduction in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.getChannelNoiseReduction(int)

getChannelStats

public double[] getChannelStats(int w)

Implemented as specified by the RenderingEngine interface.

Specified by:

getChannelStats in interface omeis.providers.re.RenderingEngine

getChannelWindowEnd

public double getChannelWindowEnd(int w)

Implemented as specified by the RenderingEngine interface.

Specified by:

getChannelWindowEnd in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.getChannelWindowEnd(int)

getChannelWindowStart

public double getChannelWindowStart(int w)

Implemented as specified by the RenderingEngine interface.

Specified by:

getChannelWindowStart in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.getChannelWindowStart(int)

getRGBA

public int[] getRGBA(int w)

Implemented as specified by the RenderingEngine interface.

Specified by:

getRGBA in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.getRGBA(int)

isActive

public boolean isActive(int w)

Implemented as specified by the RenderingEngine interface.

Specified by:

isActive in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.isActive(int)

getChannelLookupTable

public java.lang.String getChannelLookupTable(int w)

Specified by:

getChannelLookupTable in interface omeis.providers.re.RenderingEngine

setChannelLookupTable

public void setChannelLookupTable(int w,
                                  java.lang.String lookup)

Specified by:

setChannelLookupTable in interface omeis.providers.re.RenderingEngine

getDefaultT

public int getDefaultT()

Implemented as specified by the RenderingEngine interface.

Specified by:

getDefaultT in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.getDefaultT()

getDefaultZ

public int getDefaultZ()

Implemented as specified by the RenderingEngine interface.

Specified by:

getDefaultZ in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.getDefaultZ()

getModel

public ome.model.enums.RenderingModel getModel()

Implemented as specified by the RenderingEngine interface.

Specified by:

getModel in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.getModel()

getQuantumDef

public ome.model.display.QuantumDef getQuantumDef()

Implemented as specified by the RenderingEngine interface.

Specified by:

getQuantumDef in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.getQuantumDef()

getPixels

public ome.model.core.Pixels getPixels()

Implemented as specified by the RenderingEngine interface.

Specified by:

getPixels in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.getPixels()

getAvailableModels

public java.util.List getAvailableModels()

Implemented as specified by the RenderingEngine interface.

Specified by:

getAvailableModels in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.getAvailableModels()

getAvailableFamilies

public java.util.List getAvailableFamilies()

Implemented as specified by the RenderingEngine interface.

Specified by:

getAvailableFamilies in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.getAvailableFamilies()

addCodomainMap

@Deprecated
public void addCodomainMap(omeis.providers.re.codomain.CodomainMapContext mapCtx)

Deprecated.

Implemented as specified by the RenderingEngine interface.

Specified by:

addCodomainMap in interface omeis.providers.re.RenderingEngine

addCodomainMapToChannel

public void addCodomainMapToChannel(omeis.providers.re.codomain.CodomainMapContext mapCtx,
                                    int w)

Implemented as specified by the RenderingEngine interface.

Specified by:

addCodomainMapToChannel in interface omeis.providers.re.RenderingEngine

removeCodomainMap

@Deprecated
public void removeCodomainMap(omeis.providers.re.codomain.CodomainMapContext mapCtx)

Deprecated.

Implemented as specified by the RenderingEngine interface.

Specified by:

removeCodomainMap in interface omeis.providers.re.RenderingEngine

removeCodomainMapFromChannel

public void removeCodomainMapFromChannel(omeis.providers.re.codomain.CodomainMapContext mapCtx,
                                         int w)

Implemented as specified by the RenderingEngine interface.

Specified by:

removeCodomainMapFromChannel in interface omeis.providers.re.RenderingEngine

updateCodomainMap

@Deprecated
public void updateCodomainMap(omeis.providers.re.codomain.CodomainMapContext mapCtx)

Deprecated.

Implemented as specified by the RenderingEngine interface.

Specified by:

updateCodomainMap in interface omeis.providers.re.RenderingEngine

setActive

public void setActive(int w,
                      boolean active)

Implemented as specified by the RenderingEngine interface.

Specified by:

setActive in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.setActive(int, boolean)

setChannelWindow

public void setChannelWindow(int w,
                             double start,
                             double end)

Implemented as specified by the RenderingEngine interface.

Specified by:

setChannelWindow in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.setChannelWindow(int, double, double)

setCodomainInterval

public void setCodomainInterval(int start,
                                int end)

Implemented as specified by the RenderingEngine interface.

Specified by:

setCodomainInterval in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.setCodomainInterval(int, int)

setDefaultT

public void setDefaultT(int t)

Implemented as specified by the RenderingEngine interface.

Specified by:

setDefaultT in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.setDefaultT(int)

setDefaultZ

public void setDefaultZ(int z)

Implemented as specified by the RenderingEngine interface.

Specified by:

setDefaultZ in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.setDefaultZ(int)

setModel

public void setModel(ome.model.enums.RenderingModel model)

Implemented as specified by the RenderingEngine interface.

Specified by:

setModel in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.setModel(RenderingModel)

setQuantizationMap

public void setQuantizationMap(int w,
                               ome.model.enums.Family family,
                               double coefficient,
                               boolean noiseReduction)

Implemented as specified by the RenderingEngine interface.

Specified by:

setQuantizationMap in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.setQuantizationMap(int, Family, double, boolean)

setQuantumStrategy

public void setQuantumStrategy(int bitResolution)

Implemented as specified by the RenderingEngine interface.

Specified by:

setQuantumStrategy in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.setQuantumStrategy(int)

setRGBA

public void setRGBA(int w,
                    int red,
                    int green,
                    int blue,
                    int alpha)

Implemented as specified by the RenderingEngine interface.

Specified by:

setRGBA in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.setRGBA(int, int, int, int, int)

isPixelsTypeSigned

public boolean isPixelsTypeSigned()

Implemented as specified by the RenderingEngine interface.

Specified by:

isPixelsTypeSigned in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.isPixelsTypeSigned()

getPixelsTypeLowerBound

public double getPixelsTypeLowerBound(int w)

Implemented as specified by the RenderingEngine interface.

Specified by:

getPixelsTypeLowerBound in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.getPixelsTypeLowerBound(int)

getResolutionLevel

public int getResolutionLevel()

Specified by:

getResolutionLevel in interface omeis.providers.re.RenderingEngine

getResolutionLevels

public int getResolutionLevels()

Specified by:

getResolutionLevels in interface omeis.providers.re.RenderingEngine

getResolutionDescriptions

public java.util.List<java.util.List<java.lang.Integer>> getResolutionDescriptions()

Specified by:

getResolutionDescriptions in interface omeis.providers.re.RenderingEngine

getTileSize

public int[] getTileSize()

Specified by:

getTileSize in interface omeis.providers.re.RenderingEngine

requiresPixelsPyramid

public boolean requiresPixelsPyramid()

Specified by:

requiresPixelsPyramid in interface omeis.providers.re.RenderingEngine

setResolutionLevel

public void setResolutionLevel(int resolutionLevel)

Specified by:

setResolutionLevel in interface omeis.providers.re.RenderingEngine

getPixelsTypeUpperBound

public double getPixelsTypeUpperBound(int w)

Implemented as specified by the RenderingEngine interface.

Specified by:

getPixelsTypeUpperBound in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.getPixelsTypeUpperBound(int)

getCodomainMapContext

public java.util.List<omeis.providers.re.codomain.CodomainMapContext> getCodomainMapContext(int w)

Implemented as specified by the RenderingEngine interface.

Specified by:

getCodomainMapContext in interface omeis.providers.re.RenderingEngine

See Also:

RenderingEngine.getCodomainMapContext(int)

errorIfInvalidState

protected void errorIfInvalidState()

errorIfNullPixels

protected void errorIfNullPixels()

Throws an ApiUsageException if the pixels are not set.

errorIfNullRenderingDef

protected void errorIfNullRenderingDef()

Throws an ApiUsageException if the rendering settings are not set.

errorIfNullRenderer

protected void errorIfNullRenderer()

Reloads the rendering engine if null and has been made passive or throws an ApiUsageException if the rendering engine is not set.