Package omero.api

Interface _IRenderingSettingsOperations

    • Method Detail

      • sanityCheckPixels_async

        void sanityCheckPixels_async​(AMD_IRenderingSettings_sanityCheckPixels __cb,
                             Pixels pFrom,
                             Pixels pTo,
                             Ice.Current __current)
                      throws ServerError
        Checks if the specified sets of pixels are compatible. Returns true if the pixels set is valid, false otherwise.
        Parameters:
        __cb - The callback object for the operation.
        pFrom - The pixels set to copy the settings from.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • getRenderingSettings_async

        void getRenderingSettings_async​(AMD_IRenderingSettings_getRenderingSettings __cb,
                                long pixelsId,
                                Ice.Current __current)
                         throws ServerError
        Returns the default rendering settings for a given pixels for the current user.
        Parameters:
        __cb - The callback object for the operation.
        pixelsId - The Id of the Pixels
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if the image qualified by imageId is unlocatable.
        ServerError

      • createNewRenderingDef_async

        void createNewRenderingDef_async​(AMD_IRenderingSettings_createNewRenderingDef __cb,
                                 Pixels pixels,
                                 Ice.Current __current)
                          throws ServerError
        Creates a new rendering definition object along with its sub-objects.
        Parameters:
        __cb - The callback object for the operation.
        pixels - The Pixels set to link to the rendering definition.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • resetDefaults_async

        void resetDefaults_async​(AMD_IRenderingSettings_resetDefaults __cb,
                         RenderingDef def,
                         Pixels pixels,
                         Ice.Current __current)
                  throws ServerError
        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 getRenderingSettings as it relies on certain objects being loaded. The rendering settings are saved upon completion.
        Parameters:
        __cb - The callback object for the operation.
        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.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • resetDefaultsNoSave_async

        void resetDefaultsNoSave_async​(AMD_IRenderingSettings_resetDefaultsNoSave __cb,
                               RenderingDef def,
                               Pixels pixels,
                               Ice.Current __current)
                        throws ServerError
        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 getRenderingSettings(long) as it relies on certain objects being loaded. The rendering settings are not saved.
        Parameters:
        __cb - The callback object for the operation.
        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.
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • resetDefaultsInImage_async

        void resetDefaultsInImage_async​(AMD_IRenderingSettings_resetDefaultsInImage __cb,
                                long imageId,
                                Ice.Current __current)
                         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:
        __cb - The callback object for the operation.
        imageId - The Id of the Image.
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if the image qualified by imageId is unlocatable.
        ServerError

      • resetDefaultsForPixels_async

        void resetDefaultsForPixels_async​(AMD_IRenderingSettings_resetDefaultsForPixels __cb,
                                  long pixelsId,
                                  Ice.Current __current)
                           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:
        __cb - The callback object for the operation.
        pixelsId - The Id of the Pixels.
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if the Pixels qualified by pixelsId is unlocatable.
        ServerError

      • resetDefaultsInDataset_async

        void resetDefaultsInDataset_async​(AMD_IRenderingSettings_resetDefaultsInDataset __cb,
                                  long datasetId,
                                  Ice.Current __current)
                           throws ServerError
        Resets a dataset's rendering settings back to those that are specified by the rendering engine intelligent pretty good image (PG) logic.
        Parameters:
        __cb - The callback object for the operation.
        datasetId - The Id of the Dataset.
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if the image qualified by datasetId is not locatable.
        ServerError

      • resetDefaultsInSet_async

        void resetDefaultsInSet_async​(AMD_IRenderingSettings_resetDefaultsInSet __cb,
                              java.lang.String type,
                              java.util.List<java.lang.Long> nodeIds,
                              Ice.Current __current)
                       throws ServerError
        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:
        __cb - The callback object for the operation.
        type - The type of nodes to handle.
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if an illegal type is used.
        ServerError

      • resetDefaultsByOwnerInSet_async

        void resetDefaultsByOwnerInSet_async​(AMD_IRenderingSettings_resetDefaultsByOwnerInSet __cb,
                                     java.lang.String type,
                                     java.util.List<java.lang.Long> nodeIds,
                                     Ice.Current __current)
                              throws ServerError
        Resets the rendering settings of a given group of containers based on the owner's (essentially a copy). Supported container types are:
        Parameters:
        __cb - The callback object for the operation.
        type - The type of nodes to handle.
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if an illegal type is used.
        ServerError

      • resetMinMaxInSet_async

        void resetMinMaxInSet_async​(AMD_IRenderingSettings_resetMinMaxInSet __cb,
                            java.lang.String type,
                            java.util.List<java.lang.Long> nodeIds,
                            Ice.Current __current)
                     throws ServerError
        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:
        __cb - The callback object for the operation.
        type - The type of nodes to handle.
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if an illegal type is used.
        ServerError

      • applySettingsToSet_async

        void applySettingsToSet_async​(AMD_IRenderingSettings_applySettingsToSet __cb,
                              long from,
                              java.lang.String toType,
                              java.util.List<java.lang.Long> nodeIds,
                              Ice.Current __current)
                       throws ServerError
        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:
        __cb - The callback object for the operation.
        from - The Id of the pixels set to copy the rendering settings from.
        toType - The type of nodes to handle.
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if an illegal type is used.
        ServerError

      • applySettingsToProject_async

        void applySettingsToProject_async​(AMD_IRenderingSettings_applySettingsToProject __cb,
                                  long from,
                                  long to,
                                  Ice.Current __current)
                           throws ServerError
        Applies rendering settings to all images in all Datasets of a given Project.
        Parameters:
        __cb - The callback object for the operation.
        from - The Id of the pixels set to copy the rendering settings from.
        to - The Id of the project container to apply settings to.
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if the rendering settings from is not locatable or the project to is not locatable.
        ServerError

      • applySettingsToDataset_async

        void applySettingsToDataset_async​(AMD_IRenderingSettings_applySettingsToDataset __cb,
                                  long from,
                                  long to,
                                  Ice.Current __current)
                           throws ServerError
        Applies rendering settings to all images in a given Dataset.
        Parameters:
        __cb - The callback object for the operation.
        from - The Id of the pixels set to copy the rendering settings from.
        to - The Id of the dataset container to apply settings to.
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if the rendering settings from is not locatable or the dataset to is not locatable.
        ServerError

      • applySettingsToImages_async

        void applySettingsToImages_async​(AMD_IRenderingSettings_applySettingsToImages __cb,
                                 long from,
                                 java.util.List<java.lang.Long> to,
                                 Ice.Current __current)
                          throws ServerError
        Applies rendering settings to a given Image.
        Parameters:
        __cb - The callback object for the operation.
        from - The Id of the pixels set to copy the rendering settings from.
        to - The Id of the image container to apply settings to.
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if the rendering settings from is not locatable or the image to is not locatable.
        ServerError

      • applySettingsToImage_async

        void applySettingsToImage_async​(AMD_IRenderingSettings_applySettingsToImage __cb,
                                long from,
                                long to,
                                Ice.Current __current)
                         throws ServerError
        Applies rendering settings to a given Image.
        Parameters:
        __cb - The callback object for the operation.
        from - The Id of the pixels set to copy the rendering settings from.
        to - The Id of the image container to apply settings to.
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if the rendering settings from is not locatable or the image to is not locatable.
        ServerError

      • applySettingsToPixels_async

        void applySettingsToPixels_async​(AMD_IRenderingSettings_applySettingsToPixels __cb,
                                 long from,
                                 long to,
                                 Ice.Current __current)
                          throws ServerError
        Applies rendering settings to a given Pixels.
        Parameters:
        __cb - The callback object for the operation.
        from - The Id of the pixels set to copy the rendering settings from.
        to - The Id of the pixels container to apply settings to.
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if the rendering settings from is not locatable or the pixelsto is not locatable.
        ServerError

      • setOriginalSettingsInImage_async

        void setOriginalSettingsInImage_async​(AMD_IRenderingSettings_setOriginalSettingsInImage __cb,
                                      long imageId,
                                      Ice.Current __current)
                               throws ServerError
        Resets an image's default rendering settings back to channel global minimum and maximum.
        Parameters:
        __cb - The callback object for the operation.
        imageId - The Id of the Image.
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if the image qualified by imageId is not locatable.
        ServerError

      • setOriginalSettingsForPixels_async

        void setOriginalSettingsForPixels_async​(AMD_IRenderingSettings_setOriginalSettingsForPixels __cb,
                                        long pixelsId,
                                        Ice.Current __current)
                                 throws ServerError
        Resets an Pixels' default rendering settings back to channel global minimum and maximum.
        Parameters:
        __cb - The callback object for the operation.
        pixelsId - The Id of the Pixels set.
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if the image qualified by pixelsId is not locatable.
        ServerError

      • setOriginalSettingsInDataset_async

        void setOriginalSettingsInDataset_async​(AMD_IRenderingSettings_setOriginalSettingsInDataset __cb,
                                        long datasetId,
                                        Ice.Current __current)
                                 throws ServerError
        Resets a dataset's rendering settings back to channel global minimum and maximum.
        Parameters:
        __cb - The callback object for the operation.
        datasetId - The id of the dataset to handle.
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if the image qualified by datasetId is not locatable.
        ServerError

      • setOriginalSettingsInSet_async

        void setOriginalSettingsInSet_async​(AMD_IRenderingSettings_setOriginalSettingsInSet __cb,
                                    java.lang.String type,
                                    java.util.List<java.lang.Long> nodeIds,
                                    Ice.Current __current)
                             throws ServerError
        Resets a rendering settings back to channel global minimum and maximum for the specified containers. Supported container types are:
        Parameters:
        __cb - The callback object for the operation.
        type - The type of nodes to handle.
        __current - The Current object for the invocation.
        Throws:
        ValidationException - if an illegal type is used.
        ServerError