Package omero.api

Interface _IPixelsOperationsNC

    • Method Detail

      • retrievePixDescription_async

        void retrievePixDescription_async​(AMD_IPixels_retrievePixDescription __cb,
                                  long pixId)
                           throws ServerError
        Retrieves the pixels metadata. The following objects are pre-linked:
        • pixels.pixelsType
        • pixels.pixelsDimensions
        • pixels.channels
        • pixels.channnels.statsInfo
        • pixels.channnels.colorComponent
        • pixels.channnels.logicalChannel
        • pixels.channnels.logicalChannel.photometricInterpretation
        Parameters:
        __cb - The callback object for the operation.
        pixId - Pixels id.
        Throws:
        ServerError

      • retrieveRndSettings_async

        void retrieveRndSettings_async​(AMD_IPixels_retrieveRndSettings __cb,
                               long pixId)
                        throws ServerError
        Retrieves the rendering settings for a given pixels set and the currently logged in user. If the current user has no 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:
        • renderingDef.quantization
        • renderingDef.model
        • renderingDef.waveRendering
        • renderingDef.waveRendering.color
        • renderingDef.waveRendering.family
        • renderingDef.spatialDomainEnhancement
        Parameters:
        __cb - The callback object for the operation.
        pixId - Pixels id.
        Throws:
        ServerError

      • retrieveRndSettingsFor_async

        void retrieveRndSettingsFor_async​(AMD_IPixels_retrieveRndSettingsFor __cb,
                                  long pixId,
                                  long userId)
                           throws ServerError
        Retrieves the rendering settings for a given pixels set and the passed user. The following objects are pre-linked:
        • renderingDef.quantization
        • renderingDef.model
        • renderingDef.waveRendering
        • renderingDef.waveRendering.color
        • renderingDef.waveRendering.family
        • renderingDef.spatialDomainEnhancement
        Parameters:
        __cb - The callback object for the operation.
        pixId - Pixels id.
        Throws:
        ServerError

      • retrieveAllRndSettings_async

        void retrieveAllRndSettings_async​(AMD_IPixels_retrieveAllRndSettings __cb,
                                  long pixId,
                                  long userId)
                           throws ServerError
        Retrieves all the rendering settings for a given pixels set and the passed user. The following objects are pre-linked:
        • renderingDef.quantization
        • renderingDef.model
        • renderingDef.waveRendering
        • renderingDef.waveRendering.color
        • renderingDef.waveRendering.family
        • renderingDef.spatialDomainEnhancement
        Parameters:
        __cb - The callback object for the operation.
        pixId - Pixels id.
        Throws:
        ServerError

      • loadRndSettings_async

        void loadRndSettings_async​(AMD_IPixels_loadRndSettings __cb,
                           long renderingSettingsId)
                    throws ServerError
        Loads a specific set of rendering settings. The following objects are pre-linked:
        • renderingDef.quantization
        • renderingDef.model
        • renderingDef.waveRendering
        • renderingDef.waveRendering.color
        • renderingDef.waveRendering.family
        • renderingDef.spatialDomainEnhancement
        Parameters:
        __cb - The callback object for the operation.
        renderingSettingsId - Rendering definition id.
        Throws:
        ValidationException - If no RenderingDef matches the ID renderingDefId.
        ServerError

      • getEnumeration_async

        void getEnumeration_async​(AMD_IPixels_getEnumeration __cb,
                          java.lang.String enumClass,
                          java.lang.String value)
                   throws ServerError
        Deprecated.
        Use ITypes#getEnumeration(string, string) instead.
        Retrieves a particular enumeration for a given enumeration class.
        Parameters:
        __cb - The callback object for the operation.
        enumClass - Enumeration class.
        Throws:
        ServerError

      • getAllEnumerations_async

        void getAllEnumerations_async​(AMD_IPixels_getAllEnumerations __cb,
                              java.lang.String enumClass)
                       throws ServerError
        Deprecated.
        Use ITypes#allEnumerations(string) instead.
        Retrieves the exhaustive list of enumerations for a given enumeration class.
        Parameters:
        __cb - The callback object for the operation.
        enumClass - Enumeration class.
        Throws:
        ServerError

      • copyAndResizePixels_async

        void copyAndResizePixels_async​(AMD_IPixels_copyAndResizePixels __cb,
                               long pixelsId,
                               RInt sizeX,
                               RInt sizeY,
                               RInt sizeZ,
                               RInt sizeT,
                               java.util.List<java.lang.Integer> channelList,
                               java.lang.String methodology,
                               boolean copyStats)
                        throws ServerError
        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. It is beyond the scope of this method to handle updates or changes to the raw pixel data available through 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.
        Parameters:
        __cb - The callback object for the operation.
        pixelsId - The source Pixels set id.
        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.
        Throws:
        ValidationException - If the X, Y, Z, T or channelList dimensions are out of bounds or the Pixels object corresponding to pixelsId is unlocatable.
        ServerError

      • copyAndResizeImage_async

        void copyAndResizeImage_async​(AMD_IPixels_copyAndResizeImage __cb,
                              long imageId,
                              RInt sizeX,
                              RInt sizeY,
                              RInt sizeZ,
                              RInt sizeT,
                              java.util.List<java.lang.Integer> channelList,
                              java.lang.String methodology,
                              boolean copyStats)
                       throws ServerError
        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. It is beyond the scope of this method to handle updates or changes to the raw pixel data available through 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.
        Parameters:
        __cb - The callback object for the operation.
        imageId - The source Image id.
        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 - The name of the new Image.
        Throws:
        ValidationException - If the X, Y, Z, T or channelList dimensions are out of bounds or the Pixels object corresponding to pixelsId is unlocatable.
        ServerError

      • createImage_async

        void createImage_async​(AMD_IPixels_createImage __cb,
                       int sizeX,
                       int sizeY,
                       int sizeZ,
                       int sizeT,
                       java.util.List<java.lang.Integer> channelList,
                       PixelsType pixelsType,
                       java.lang.String name,
                       java.lang.String description)
                throws ServerError
        Creates the metadata, and only the metadata linked to an Image object. It is beyond the scope of this method to handle updates or changes to the raw pixel data available through 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.
        Parameters:
        __cb - The callback object for the operation.
        sizeX - The new size across the X-axis.
        sizeZ - The new size across the Z-axis.
        pixelsType - The pixelsType
        description - The description of the new Image.
        Throws:
        ValidationException - If the channel list is null or of size == 0.
        ServerError

      • setChannelGlobalMinMax_async

        void setChannelGlobalMinMax_async​(AMD_IPixels_setChannelGlobalMinMax __cb,
                                  long pixelsId,
                                  int channelIndex,
                                  double min,
                                  double max)
                           throws ServerError
        Sets the channel global (all 2D optical sections corresponding to a particular channel) minimum and maximum for a Pixels set.
        Parameters:
        __cb - The callback object for the operation.
        pixelsId - The source Pixels set id.
        min - The channel global minimum.
        Throws:
        ServerError