omero::api::IRenderingSettings
Overview
[ "ami", "amd" ]
interface IRenderingSettings extends ServiceInterface
Provides method to apply rendering settings to a collection of
images.
All methods will receive the id of the pixels set to copy the
rendering settings from.
Operation Index
- sanityCheckPixels
-
Checks if the specified sets of pixels are compatible.
- getRenderingSettings
-
Returns the default rendering settings for a given pixels
for the current user.
- createNewRenderingDef
-
Creates a new rendering definition object along with its
sub-objects.
- resetDefaults
-
Resets the given rendering settings to those that are
specified by the rendering engine intelligent pretty
good image (PG) logic for the pixels set linked to that
set of rendering settings.
- resetDefaultsNoSave
-
Resets the given rendering settings to those that are
specified by the rendering engine intelligent pretty
good image (PG) logic for the pixels set linked to that
set of rendering settings.
- resetDefaultsInImage
-
Resets an image's default rendering settings back to those
that are specified by the rendering engine intelligent
pretty good image (PG) logic.
- resetDefaultsForPixels
-
Resets a Pixels' default rendering settings back to those
that are specified by the rendering engine intelligent
pretty good image (PG) logic.
- resetDefaultsInDataset
-
Resets a dataset's rendering settings back to those that
are specified by the rendering engine intelligent pretty
good image (PG) logic.
- resetDefaultsInSet
-
Resets a rendering settings back to one or many containers
that are specified by the rendering engine intelligent
pretty good image (PG) logic.
- resetDefaultsByOwnerInSet
-
Resets the rendering settings of a given group of
containers based on the owner's (essentially a copy).
- resetMinMaxInSet
-
Resets a the channel windows for one or many containers
back to their global minimum and global maximum for the
channel.
- applySettingsToSet
-
Applies rendering settings to one or many containers.
- applySettingsToProject
-
Applies rendering settings to all images in all Datasets of
a given Project.
- applySettingsToDataset
-
Applies rendering settings to all images in a given Dataset.
- applySettingsToImages
-
Applies rendering settings to a given Image.
- applySettingsToImage
-
Applies rendering settings to a given Image.
- applySettingsToPixels
-
Applies rendering settings to a given Pixels.
- setOriginalSettingsInImage
-
Resets an image's default rendering settings back to
channel global minimum and maximum.
- setOriginalSettingsForPixels
-
Resets an Pixels' default rendering settings back to
channel global minimum and maximum.
- setOriginalSettingsInDataset
-
Resets a dataset's rendering settings back to channel global
minimum and maximum.
- setOriginalSettingsInSet
-
Resets a rendering settings back to channel global minimum
and maximum for the specified containers.
Operations
Checks if the specified sets of pixels are compatible.
Returns true
if the pixels set is valid,
false
otherwise.
Parameters
- pFrom
-
The pixels set to copy the settings from.
- pTo
-
The pixels set to copy the settings to.
Return Value
See above.
Returns the default rendering settings for a given pixels
for the current user.
Parameters
- pixelsId
-
The Id of the Pixels
Return Value
See above.
Exceptions
- ValidationException
-
if the image qualified by
imageId
is unlocatable.
Creates a new rendering definition object along with its
sub-objects.
Parameters
- pixels
-
The Pixels set to link to the rendering
definition.
Return Value
A new, blank rendering definition and sub-objects.
NOTE: the linked Pixels has been unloaded.
Resets the given rendering settings to those that are
specified by the rendering engine intelligent pretty
good image (PG) logic for the pixels set linked to that
set of rendering settings. NOTE: This method should
only be used to reset a rendering definition that has been
retrieved via {@code getRenderingSettings} as it
relies on certain objects being loaded. The rendering
settings are saved upon completion.
Parameters
- def
-
A RenderingDef to reset. It is expected that
def.pixels will be unloaded and that the
actual linked Pixels set will be provided in the
pixels
argument.
- pixels
-
The Pixels set for
def
.
Resets the given rendering settings to those that are
specified by the rendering engine intelligent pretty
good image (PG) logic for the pixels set linked to that
set of rendering settings. NOTE: This method should
only be used to reset a rendering definition that has been
retrieved via {@code getRenderingSettings(long)} as it
relies on certain objects being loaded. The rendering
settings are not saved.
Parameters
- def
-
A RenderingDef to reset. It is expected that
def.pixels will be unloaded and that the
actual linked Pixels set will be provided in the
pixels
argument.
- pixels
-
The Pixels set for
def
.
Return Value
def
with the rendering settings reset.
void resetDefaultsInImage(long imageId) throws ServerError
Resets an image's default rendering settings back to those
that are specified by the rendering engine intelligent
pretty good image (PG) logic.
Parameters
- imageId
-
The Id of the Image.
Exceptions
- ValidationException
-
if the image qualified by
imageId
is unlocatable.
void resetDefaultsForPixels(long pixelsId) throws ServerError
Resets a Pixels' default rendering settings back to those
that are specified by the rendering engine intelligent
pretty good image (PG) logic.
Parameters
- pixelsId
-
The Id of the Pixels.
Exceptions
- ValidationException
-
if the Pixels qualified by
pixelsId
is unlocatable.
Resets a dataset's rendering settings back to those that
are specified by the rendering engine intelligent pretty
good image (PG) logic.
Parameters
- datasetId
-
The Id of the Dataset.
Return Value
A java::util::Set of image IDs that have had
their rendering settings reset.
Exceptions
- ValidationException
-
if the image qualified by
datasetId
is not locatable.
Resets a rendering settings back to one or many containers
that are specified by the rendering engine intelligent
pretty good image (PG) logic. Supported container
types are:
Parameters
- type
-
The type of nodes to handle.
- nodeIds
-
Ids of the node type.
Return Value
A java::util::Set of image IDs that have had
their rendering settings reset.
Exceptions
- ValidationException
-
if an illegal
type
is used.
Resets the rendering settings of a given group of
containers based on the owner's (essentially a copy).
Supported container types are:
Parameters
- type
-
The type of nodes to handle.
- nodeIds
-
Ids of the node type.
Return Value
A java::util::Set of image IDs that have
had their rendering settings reset.
Exceptions
- ValidationException
-
if an illegal
type
is used.
Resets a the channel windows for one or many containers
back to their global minimum and global maximum for the
channel. Supported container types are:
Parameters
- type
-
The type of nodes to handle.
- nodeIds
-
Ids of the node type.
Return Value
A java::util::Set of image IDs that have
had their rendering settings reset.
Exceptions
- ValidationException
-
if an illegal
type
is used.
Applies rendering settings to one or many containers. If a
container such as Dataset is to be copied to, all images
within that Dataset will have the rendering settings
applied. Supported container types are:
Parameters
- from
-
The Id of the pixels set to copy the rendering
settings from.
- toType
-
The type of nodes to handle.
- nodeIds
-
Ids of the node type.
Return Value
A map with two boolean keys. The value of the key
TRUE
is a collection of image IDs, the
settings were successfully applied to.
The value of the key FALSE
is a collection
of image IDs, the settings could not be applied to.
Exceptions
- ValidationException
-
if an illegal
type
is used.
Applies rendering settings to all images in all Datasets of
a given Project.
Parameters
- from
-
The Id of the pixels set to copy the rendering
settings from.
- to
-
The Id of the project container to apply settings
to.
Return Value
A map with two boolean keys. The value of the
TRUE
is a collection of images ID, the
settings were successfully applied to.
The value of the FALSE
is a collection
of images ID, the settings could not be applied to.
Exceptions
- ValidationException
-
if the rendering settings
from
is not locatable or the project
to
is not locatable.
Applies rendering settings to all images in a given Dataset.
Parameters
- from
-
The Id of the pixels set to copy the rendering
settings from.
- to
-
The Id of the dataset container to apply settings
to.
Return Value
A map with two boolean keys. The value of the
TRUE
is a collection of images ID, the
settings were successfully applied to.
The value of the FALSE
is a collection
of images ID, the settings could not be applied to.
Exceptions
- ValidationException
-
if the rendering settings
from
is not locatable or the dataset
to
is not locatable.
Applies rendering settings to a given Image.
Parameters
- from
-
The Id of the pixels set to copy the rendering
settings from.
- to
-
The Id of the image container to apply settings
to.
Return Value
true
if the settings were successfully
applied, false
otherwise.
Exceptions
- ValidationException
-
if the rendering settings
from
is not locatable or the image
to
is not locatable.
bool applySettingsToImage(long from, long to) throws ServerError
Applies rendering settings to a given Image.
Parameters
- from
-
The Id of the pixels set to copy the rendering
settings from.
- to
-
The Id of the image container to apply settings
to.
Return Value
true
if the settings were successfully
applied, false
otherwise.
Exceptions
- ValidationException
-
if the rendering settings
from
is not locatable or the image
to
is not locatable.
bool applySettingsToPixels(long from, long to) throws ServerError
Applies rendering settings to a given Pixels.
Parameters
- from
-
The Id of the pixels set to copy the rendering
settings from.
- to
-
The Id of the pixels container to apply settings
to.
Return Value
See above.
Exceptions
- ValidationException
-
if the rendering settings
from
is not locatable or the
pixelsto
is not locatable.
void setOriginalSettingsInImage(long imageId) throws ServerError
Resets an image's default rendering settings back to
channel global minimum and maximum.
Parameters
- imageId
-
The Id of the Image.
Exceptions
- ValidationException
-
if the image qualified by
imageId
is not locatable.
void setOriginalSettingsForPixels(long pixelsId) throws ServerError
Resets an Pixels' default rendering settings back to
channel global minimum and maximum.
Parameters
- pixelsId
-
The Id of the Pixels set.
Exceptions
- ValidationException
-
if the image qualified by
pixelsId
is not locatable.
sys::LongList setOriginalSettingsInDataset(long datasetId) throws ServerError
Resets a dataset's rendering settings back to channel global
minimum and maximum.
Parameters
- datasetId
-
The id of the dataset to handle.
Return Value
A java::util::Set of image IDs that have
had their rendering settings reset.
Exceptions
- ValidationException
-
if the image qualified by
datasetId
is not locatable.
Resets a rendering settings back to channel global minimum
and maximum for the specified containers. Supported
container types are:
Parameters
- type
-
The type of nodes to handle.
- nodeIds
-
Ids of the node type.
Return Value
A java::util::Set of image IDs that have
had their rendering settings reset.
Exceptions
- ValidationException
-
if an illegal
type
is used.