Package omero.api

Interface _RenderingEngineOperationsNC

  • All Superinterfaces:
    _PyramidServiceOperationsNC, _ServiceInterfaceOperationsNC, _StatefulServiceInterfaceOperationsNC
    All Known Subinterfaces:
    RenderingEngine
    All Known Implementing Classes:
    _RenderingEngineDisp, _RenderingEngineTie
    public interface _RenderingEngineOperationsNC
extends _PyramidServiceOperationsNC
    Defines a service to render a given pixels set. A pixels set is a 5D array that stores the pixels data of an image, that is the pixels intensity values. Every instance of this service is paired up to a pixels set. Use this service to transform planes within the pixels set onto an RGB image. The RenderingEngine allows to fine-tune the settings that define the transformation context, that is, a specification of how raw pixels data is to be transformed into an image that can be displayed on screen. Those settings are referred to as rendering settings or display options. After tuning those settings it is possible to save them to the metadata repository so that they can be used the next time the pixels set is accessed for rendering; for example by another RenderingEngine instance. Note that the display options are specific to the given pixels set and are experimenter scoped i.e. two different users can specify different display options for the same pixels set. (A RenderingEngine instance takes this into account automatically as it is always bound to a given experimenter.) This service is thread-safe.

    • Method Detail

      • render_async

        void render_async​(AMD_RenderingEngine_render __cb,
                  PlaneDef def)
           throws ServerError
        Renders the data selected by def according to the current rendering settings. The passed argument selects a plane orthogonal to one of the X, Y, or Z axes. How many wavelengths are rendered and what color model is used depends on the current rendering settings.
        Parameters:
        __cb - The callback object for the operation.
        def - Selects a plane orthogonal to one of the X, Y, or Z axes.
        Throws:
        ValidationException - If def is null.
        ServerError

      • renderAsPackedInt_async

        void renderAsPackedInt_async​(AMD_RenderingEngine_renderAsPackedInt __cb,
                             PlaneDef def)
                      throws ServerError
        Renders the data selected by def according to the current rendering settings. The passed argument selects a plane orthogonal to one of the X, Y, or Z axes. How many wavelengths are rendered and what color model is used depends on the current rendering settings.
        Parameters:
        __cb - The callback object for the operation.
        def - Selects a plane orthogonal to one of the X, Y, or Z axes.
        Throws:
        ValidationException - If def is null.
        ServerError

      • renderProjectedAsPackedInt_async

        void renderProjectedAsPackedInt_async​(AMD_RenderingEngine_renderProjectedAsPackedInt __cb,
                                      ProjectionType algorithm,
                                      int timepoint,
                                      int stepping,
                                      int start,
                                      int end)
                               throws ServerError
        Performs a projection through selected optical sections of a particular timepoint with the currently active channels and renders the data for display.
        Parameters:
        __cb - The callback object for the operation.
        algorithm - IProjection.MAXIMUM_INTENSITY, IProjection.MEAN_INTENSITY or IProjection.SUM_INTENSITY.
        stepping - Stepping value to use while calculating the projection. For example, stepping=1 will use every optical section from start to end where stepping=2 will use every other section from start to end to perform the projection.
        start - Optical section to start projecting from.
        Throws:
        ValidationException - Where:
        • algorithm is unknown
        • timepoint is out of range
        • start is out of range
        • end is out of range
        • start is greater than end
        ServerError

      • renderCompressed_async

        void renderCompressed_async​(AMD_RenderingEngine_renderCompressed __cb,
                            PlaneDef def)
                     throws ServerError
        Renders the data selected by def according to the current rendering settings and compresses the resulting RGBA composite image.
        Parameters:
        __cb - The callback object for the operation.
        def - Selects a plane orthogonal to one of the X, Y or Z axes.
        Throws:
        ValidationException - If def is null.
        ServerError

      • renderProjectedCompressed_async

        void renderProjectedCompressed_async​(AMD_RenderingEngine_renderProjectedCompressed __cb,
                                     ProjectionType algorithm,
                                     int timepoint,
                                     int stepping,
                                     int start,
                                     int end)
                              throws ServerError
        Performs a projection through selected optical sections of a particular timepoint with the currently active channels, renders the data for display and compresses the resulting RGBA composite image.
        Parameters:
        __cb - The callback object for the operation.
        algorithm - IProjection.MAXIMUM_INTENSITY, IProjection.MEAN_INTENSITY or IProjection.SUM_INTENSITY.
        stepping - Stepping value to use while calculating the projection. For example, stepping=1 will use every optical section from start to end where stepping=2 will use every other section from start to end to perform the projection.
        start - Optical section to start projecting from.
        Throws:
        ValidationException - Where:
        • algorithm is unknown
        • timepoint is out of range
        • start is out of range
        • end is out of range
        • startis greater than end
        ServerError

      • lookupPixels_async

        void lookupPixels_async​(AMD_RenderingEngine_lookupPixels __cb,
                        long pixelsId)
                 throws ServerError
        Loads the Pixels set this Rendering Engine is for.
        Parameters:
        __cb - The callback object for the operation.
        pixelsId - The pixels set ID.
        Throws:
        ServerError

      • lookupRenderingDef_async

        void lookupRenderingDef_async​(AMD_RenderingEngine_lookupRenderingDef __cb,
                              long pixelsId)
                       throws ServerError
        Loads the rendering settings associated to the specified pixels set.
        Parameters:
        __cb - The callback object for the operation.
        pixelsId - The pixels set ID.
        Throws:
        ServerError

      • loadRenderingDef_async

        void loadRenderingDef_async​(AMD_RenderingEngine_loadRenderingDef __cb,
                            long renderingDefId)
                     throws ServerError
        Loads a specific set of rendering settings that does not necessarily have to be linked to the given Pixels set. However, the rendering settings must be linked to a compatible Pixels set as defined by omero.api.IRenderingSettings.sanityCheckPixels.
        Parameters:
        __cb - The callback object for the operation.
        renderingDefId - The rendering definition ID.
        Throws:
        ValidationException - If a RenderingDef does not exist with the ID renderingDefId or if the RenderingDef is incompatible due to differing pixels sets.
        ServerError

      • setOverlays_async

        void setOverlays_async​(AMD_RenderingEngine_setOverlays __cb,
                       RLong tablesId,
                       RLong imageId,
                       java.util.Map<java.lang.Long,​java.lang.Integer> rowColorMap)
                throws ServerError
        Deprecated.
        use omero::romio::PlaneDefWithMasks instead
        Informs the rendering engine that it should render a set of overlays on each rendered frame. These are expected to be binary masks.
        Parameters:
        __cb - The callback object for the operation.
        rowColorMap - Binary mask to color map.
        Throws:
        ServerError

      • setModel_async

        void setModel_async​(AMD_RenderingEngine_setModel __cb,
                    RenderingModel model)
             throws ServerError
        Specifies the model that dictates how transformed raw data has to be mapped onto a color space.
        Parameters:
        __cb - The callback object for the operation.
        model - Identifies the color space model.
        Throws:
        ServerError

      • getModel_async

        void getModel_async​(AMD_RenderingEngine_getModel __cb)
             throws ServerError
        Returns the model that dictates how transformed raw data has to be mapped onto a color space.
        Parameters:
        __cb - The callback object for the operation.
        Throws:
        ServerError

      • setDefaultZ_async

        void setDefaultZ_async​(AMD_RenderingEngine_setDefaultZ __cb,
                       int z)
                throws ServerError
        Sets the index of the default focal section. This index is used to define a default plane.
        Parameters:
        __cb - The callback object for the operation.
        z - The value to set.
        Throws:
        ServerError

      • setDefaultT_async

        void setDefaultT_async​(AMD_RenderingEngine_setDefaultT __cb,
                       int t)
                throws ServerError
        Sets the default timepoint index. This index is used to define a default plane.
        Parameters:
        __cb - The callback object for the operation.
        t - The value to set.
        Throws:
        ServerError

      • setQuantumStrategy_async

        void setQuantumStrategy_async​(AMD_RenderingEngine_setQuantumStrategy __cb,
                              int bitResolution)
                       throws ServerError
        Sets the quantization strategy. The strategy is common to all channels.
        Parameters:
        __cb - The callback object for the operation.
        bitResolution - The bit resolution defining associated to the strategy.
        Throws:
        ServerError

      • setCodomainInterval_async

        void setCodomainInterval_async​(AMD_RenderingEngine_setCodomainInterval __cb,
                               int start,
                               int end)
                        throws ServerError
        Sets the sub-interval of the device space i.e. a discrete sub-interval of \[0, 255].
        Parameters:
        __cb - The callback object for the operation.
        start - The lower bound of the interval.
        Throws:
        ServerError

      • setQuantizationMap_async

        void setQuantizationMap_async​(AMD_RenderingEngine_setQuantizationMap __cb,
                              int w,
                              Family family,
                              double coefficient,
                              boolean noiseReduction)
                       throws ServerError
        Sets the quantization map, one per channel.
        Parameters:
        __cb - The callback object for the operation.
        w - The channel index.
        coefficient - The coefficient identifying a curve in the family.
        noiseReduction - Pass true to turn the noise reduction algorithm on, false otherwise.
        Throws:
        ServerError

      • getChannelNoiseReduction_async

        void getChannelNoiseReduction_async​(AMD_RenderingEngine_getChannelNoiseReduction __cb,
                                    int w)
                             throws ServerError
        Returns true if the noise reduction algorithm used to map the pixels intensity values is turned on, false if the algorithm is turned off. Each channel has an algorithm associated to it.
        Parameters:
        __cb - The callback object for the operation.
        w - The channel index.
        Throws:
        ServerError

      • getChannelCurveCoefficient_async

        void getChannelCurveCoefficient_async​(AMD_RenderingEngine_getChannelCurveCoefficient __cb,
                                      int w)
                               throws ServerError
        Returns the coefficient identifying a map in the family. Each channel has a map associated to it.
        Parameters:
        __cb - The callback object for the operation.
        w - The channel index.
        Throws:
        ServerError

      • setChannelWindow_async

        void setChannelWindow_async​(AMD_RenderingEngine_setChannelWindow __cb,
                            int w,
                            double start,
                            double end)
                     throws ServerError
        Returns the pixels intensity interval. Each channel has a pixels intensity interval associated to it.
        Parameters:
        __cb - The callback object for the operation.
        w - The channel index.
        end - The upper bound of the interval.
        Throws:
        ServerError

      • getChannelWindowStart_async

        void getChannelWindowStart_async​(AMD_RenderingEngine_getChannelWindowStart __cb,
                                 int w)
                          throws ServerError
        Returns the lower bound of the pixels intensity interval. Each channel has a pixels intensity interval associated to it.
        Parameters:
        __cb - The callback object for the operation.
        w - The channel index.
        Throws:
        ServerError

      • getChannelWindowEnd_async

        void getChannelWindowEnd_async​(AMD_RenderingEngine_getChannelWindowEnd __cb,
                               int w)
                        throws ServerError
        Returns the upper bound of the pixels intensity interval. Each channel has a pixels intensity interval associated to it.
        Parameters:
        __cb - The callback object for the operation.
        w - The channel index.
        Throws:
        ServerError

      • setRGBA_async

        void setRGBA_async​(AMD_RenderingEngine_setRGBA __cb,
                   int w,
                   int red,
                   int green,
                   int blue,
                   int alpha)
            throws ServerError
        Sets the four components composing the color associated to the specified channel.
        Parameters:
        __cb - The callback object for the operation.
        w - The channel index.
        green - The green component. A value between 0 and 255.
        alpha - The alpha component. A value between 0 and 255.
        Throws:
        ServerError

      • getRGBA_async

        void getRGBA_async​(AMD_RenderingEngine_getRGBA __cb,
                   int w)
            throws ServerError
        Returns a 4D-array representing the color associated to the specified channel. The first element corresponds to the red component (value between 0 and 255). The second corresponds to the green component (value between 0 and 255). The third corresponds to the blue component (value between 0 and 255). The fourth corresponds to the alpha component (value between 0 and 255).
        Parameters:
        __cb - The callback object for the operation.
        w - The channel index.
        Throws:
        ServerError

      • setActive_async

        void setActive_async​(AMD_RenderingEngine_setActive __cb,
                     int w,
                     boolean active)
              throws ServerError
        Maps the specified channel if true, unmaps the channel otherwise.
        Parameters:
        __cb - The callback object for the operation.
        w - The channel index.
        Throws:
        ServerError

      • isActive_async

        void isActive_async​(AMD_RenderingEngine_isActive __cb,
                    int w)
             throws ServerError
        Returns true if the channel is mapped, false otherwise.
        Parameters:
        __cb - The callback object for the operation.
        w - The channel index.
        Throws:
        ServerError

      • addCodomainMap_async

        void addCodomainMap_async​(AMD_RenderingEngine_addCodomainMap __cb,
                          CodomainMapContext mapCtx)
                   throws ServerError
        Deprecated.
        addCodomainMap() is deprecated. use addCodomainMapToChannel instead.
        Adds the context to the mapping chain. Only one context of the same type can be added to the chain. The codomain transformations are functions from the device space to device space. Each time a new context is added, the second LUT is rebuilt.
        Parameters:
        __cb - The callback object for the operation.
        mapCtx - The context to add.
        Throws:
        ServerError

      • updateCodomainMap_async

        void updateCodomainMap_async​(AMD_RenderingEngine_updateCodomainMap __cb,
                             CodomainMapContext mapCtx)
                      throws ServerError
        Deprecated.
        removeCodomainMap() is deprecated.
        Updates the specified context. The codomain chain already contains the specified context. Each time a new context is updated, the second LUT is rebuilt.
        Parameters:
        __cb - The callback object for the operation.
        mapCtx - The context to update.
        Throws:
        ServerError

      • removeCodomainMap_async

        void removeCodomainMap_async​(AMD_RenderingEngine_removeCodomainMap __cb,
                             CodomainMapContext mapCtx)
                      throws ServerError
        Deprecated.
        removeCodomainMap() is deprecated. use removeCodomainMapFromChannel instead.
        Removes the specified context from the chain. Each time a new context is removed, the second LUT is rebuilt.
        Parameters:
        __cb - The callback object for the operation.
        mapCtx - The context to remove.
        Throws:
        ServerError

      • addCodomainMapToChannel_async

        void addCodomainMapToChannel_async​(AMD_RenderingEngine_addCodomainMapToChannel __cb,
                                   CodomainMapContext mapCtx,
                                   int w)
                            throws ServerError
        Adds the context to the mapping chain. Only one context of the same type can be added to the chain. The codomain transformations are functions from the device space to device space. Each time a new context is added, the second LUT is rebuilt.
        Parameters:
        __cb - The callback object for the operation.
        mapCtx - The context to add.
        Throws:
        ServerError

      • updateSettings_async

        void updateSettings_async​(AMD_RenderingEngine_updateSettings __cb,
                          RenderingDef settings)
                   throws ServerError
        Updates the current rendering settings based on a provided rendering definition and associated sub-objects.
        Parameters:
        __cb - The callback object for the operation.
        settings - Rendering definition to copy from. Each sub-object will be processed as though the specific method was called with related attributes provided as arguments. The following methods are called underneath:
        • RenderingEngine.setModel
        • RenderingEngine.setDefaultZ
        • RenderingEngine.setDefaultT
        • RenderingEngine.setQuantumStrategy
        • RenderingEngine.setCodomainInterval
        • RenderingEngine.setActive
        • RenderingEngine.setChannelWindow
        • RenderingEngine.setQuantizationMap
        • RenderingEngine.setRGBA
        • RenderingEngine.setChannelLookupTable
        If one or more attributes that apply to a particular method are null it will be skipped in its entirety. The underlying Renderer is not able to handle partial field updates. Furthermore, ChannelBinding references that are null and indexes in the RenderingDef.WAVERENDERING array greater than the currently looked up Pixels.SIZEC will be skipped.
        Throws:
        ServerError

      • resetDefaultSettings_async

        void resetDefaultSettings_async​(AMD_RenderingEngine_resetDefaultSettings __cb,
                                boolean save)
                         throws ServerError
        Resets the default settings i.e. the default values internal to the Rendering engine. The settings will be saved.
        Parameters:
        __cb - The callback object for the operation.
        save - Pass true to save the settings, false otherwise.
        Throws:
        ServerError

      • setCompressionLevel_async

        void setCompressionLevel_async​(AMD_RenderingEngine_setCompressionLevel __cb,
                               float percentage)
                        throws ServerError
        Sets the current compression level for the service. (The default is 85%)
        Parameters:
        __cb - The callback object for the operation.
        percentage - A percentage compression level from 1.00 (100%) to 0.01 (1%).
        Throws:
        ValidationException - if the percentage is out of range.
        ServerError

      • getPixelsTypeUpperBound_async

        void getPixelsTypeUpperBound_async​(AMD_RenderingEngine_getPixelsTypeUpperBound __cb,
                                   int w)
                            throws ServerError
        Returns the minimum value for that channels depending on the pixels type and the original range (globalmin, globalmax)
        Parameters:
        __cb - The callback object for the operation.
        w - The channel index.
        Throws:
        ServerError

      • getPixelsTypeLowerBound_async

        void getPixelsTypeLowerBound_async​(AMD_RenderingEngine_getPixelsTypeLowerBound __cb,
                                   int w)
                            throws ServerError
        Returns the maximum value for that channels depending on the pixels type and the original range (globalmin, globalmax)
        Parameters:
        __cb - The callback object for the operation.
        w - The channel index.
        Throws:
        ServerError