public interface IPixels extends ServiceInterface
RenderingEngine
and
clients. This service provides all DB access that the rendering engine
needs as well as Pixels services to a client. It also allows the rendering
engine to also be run external to the server (e.g. client-side).Modifier and Type | Method and Description |
---|---|
Long |
copyAndResizeImage(long imageId,
Integer sizeX,
Integer sizeY,
Integer sizeZ,
Integer sizeT,
List<Integer> channelList,
String name,
boolean copyStats)
Copies the metadata, and only the metadata linked to a Image
object into a new Image object of equal or differing size across one
or many of its three physical dimensions or temporal dimension.
|
Long |
copyAndResizePixels(long pixelsId,
Integer sizeX,
Integer sizeY,
Integer sizeZ,
Integer sizeT,
List<Integer> channelList,
String methodology,
boolean copyStats)
Copies the metadata, and only the metadata linked to a Pixels
object into a new Pixels object of equal or differing size across one
or many of its three physical dimensions or temporal dimension.
|
Long |
createImage(int sizeX,
int sizeY,
int sizeZ,
int sizeT,
List<Integer> channelList,
PixelsType pixelType,
String name,
String description)
Creates the metadata, and only the metadata linked to an Image
object.
|
<T extends IObject> |
getAllEnumerations(Class<T> klass)
Retrieves the exhaustive list of enumerations for a given enumeration
class.
|
int |
getBitDepth(PixelsType type)
Bit depth for a given pixel type.
|
<T extends IObject> |
getEnumeration(Class<T> klass,
String value)
Retrieves a particular enumeration for a given enumeration class.
|
RenderingDef |
loadRndSettings(long renderingDefId)
Loads a specific set of rendering settings with the following objects
pre-linked:
renderingDef.quantization
renderingDef.model
renderingDef.waveRendering
renderingDef.waveRendering.color
renderingDef.waveRendering.family
renderingDef.spatialDomainEnhancement
|
List<IObject> |
retrieveAllRndSettings(long pixId,
long userId)
Retrieves all the rendering settings for a given pixels set and the
passed user with the following objects pre-linked:
renderingDef.quantization
renderingDef.model
renderingDef.waveRendering
renderingDef.waveRendering.color
renderingDef.waveRendering.family
renderingDef.spatialDomainEnhancement
|
Pixels |
retrievePixDescription(long pixelsId)
Retrieves the pixels metadata with the following objects pre-linked:
pixels.pixelsType
pixels.pixelsDimensions
pixels.channels
pixels.channnels.statsInfo
pixels.channnels.colorComponent
pixels.channnels.logicalChannel
pixels.channnels.logicalChannel.photometricInterpretation
|
RenderingDef |
retrieveRndSettings(long pixelsId)
Retrieves the rendering settings for a given pixels set and the currently
logged in user.
|
RenderingDef |
retrieveRndSettingsFor(long pixelsId,
long userID)
Retrieves the rendering settings for a given pixels set and the passed
user with the following objects pre-linked:
renderingDef.quantization
renderingDef.model
renderingDef.waveRendering
renderingDef.waveRendering.color
renderingDef.waveRendering.family
renderingDef.spatialDomainEnhancement
|
void |
saveRndSettings(RenderingDef rndSettings)
Saves the specified rendering settings.
|
void |
setChannelGlobalMinMax(long pixelsId,
int channelIndex,
double min,
double max)
Sets the channel global (all 2D optical sections corresponding to a
particular channel) minimum and maximum for a Pixels set.
|
Pixels retrievePixDescription(long pixelsId)
pixelsId
- Pixels id.RenderingDef retrieveRndSettings(long pixelsId)
RenderingDef
, and the
user is an administrator, then a RenderingDef
may be returned
for the owner of the Pixels
. This matches the behavior of the
Rendering service.
The following objects will be pre-linked:
pixelsId
- Pixels id.RenderingDef retrieveRndSettingsFor(long pixelsId, long userID)
pixelsId
- Pixels id.userID
- The id of the user.List<IObject> retrieveAllRndSettings(long pixId, long userId)
pixId
- Pixels id.userId
- The id of the user.RenderingDef loadRndSettings(long renderingDefId)
renderingDefId
- Rendering definition id.ValidationException
- If no RenderingDef
matches the
ID renderingDefId
.Long copyAndResizePixels(long pixelsId, Integer sizeX, Integer sizeY, Integer sizeZ, Integer sizeT, List<Integer> channelList, String methodology, boolean copyStats)
RawPixelsStore
or to add
and link PlaneInfo
and/or other Pixels set
specific metadata.
It is also assumed that the caller wishes the pixels dimensions and
PixelsType
to remain the same;
changing these is outside the scope of this method. NOTE: As
Channel
objects are only able to apply to a
single set of Pixels any annotations or linkage to these objects will
be lost.pixelsId
- The source Pixels set id.sizeX
- The new size across the X-axis. null
if the
copy should maintain the same size.sizeY
- The new size across the Y-axis. null
if the
copy should maintain the same size.sizeZ
- The new size across the Z-axis. null
if the
copy should maintain the same size.sizeT
- The new number of timepoints. null
if the
copy should maintain the same number.channelList
- The channels that should be copied into the new Pixels
set.methodology
- An optional string signifying the methodology that
will be used to produce this new Pixels set.copyStats
- Whether or not to copy the StatsInfo
for each
channel.null
on
failure.ValidationException
- If the X, Y, Z, T or channelList dimensions
are out of bounds or the Pixels object corresponding to
pixelsId
is unlocatable.Long copyAndResizeImage(long imageId, Integer sizeX, Integer sizeY, Integer sizeZ, Integer sizeT, List<Integer> channelList, String name, boolean copyStats)
RawPixelsStore
or to add
and link PlaneInfo
and/or other Pixels set specific metadata.
It is also assumed that the caller wishes the pixels dimensions and
PixelsType
to remain the same;
changing these is outside the scope of this method. NOTE: As
Channel
objects are only able to apply to a single set of
Pixels any annotations or linkage to these objects will be lost.imageId
- The source Image id.sizeX
- The new size across the X-axis. null
if the
copy should maintain the same size.sizeY
- The new size across the Y-axis. null
if the
copy should maintain the same size.sizeZ
- The new size across the Z-axis. null
if the
copy should maintain the same size.sizeT
- The new number of timepoints. null
if the
copy should maintain the same number.channelList
- The channels that should be copied into the new Pixels
set.name
- The name of the new Image.copyStats
- Whether or not to copy the StatsInfo
for each
channel.null
on
failure.ValidationException
- If the X, Y, Z, T or channelList dimensions
are out of bounds or the Pixels object corresponding to
pixelsId
is unlocatable.Long createImage(int sizeX, int sizeY, int sizeZ, int sizeT, List<Integer> channelList, PixelsType pixelType, String name, String description)
RawPixelsStore
or to add and link PlaneInfo
or StatsInfo
objects
and/or other Pixels set specific metadata. It is also up to the caller
to update the pixels dimensions.sizeX
- The new size across the X-axis.sizeY
- The new size across the Y-axis.sizeZ
- The new size across the Z-axis.sizeT
- The new number of timepoints.channelList
- The channels (emission wavelength in nanometers) that
should be added to the new Pixels set.name
- The name of the new Image.description
- The description of the new Image.null
on
failure.ValidationException
- If the channel list is null
or
of size == 0.void setChannelGlobalMinMax(long pixelsId, int channelIndex, double min, double max)
pixelsId
- The source Pixels set id.channelIndex
- The channel index within the Pixels set.min
- The channel global minimum.max
- The channel global maximum.void saveRndSettings(RenderingDef rndSettings)
rndSettings
- Rendering settings.int getBitDepth(PixelsType type)
type
- Pixels type.<T extends IObject> T getEnumeration(Class<T> klass, String value)
klass
- Enumeration class.value
- Enumeration string value.
Version: 5.2.0-ice35-b12
Copyright © 2015 The University of Dundee & Open Microscopy Environment. All Rights Reserved.