Class PixelsWrapper


  • public class PixelsWrapper
    extends GenericObjectWrapper<PixelsData>
    Class containing a PixelData object.

    Wraps function calls to the PixelData contained.

    • Field Detail

      • MAX_DIST

        public static final int MAX_DIST
        Size of tiles when retrieving pixels
        See Also:
        Constant Field Values
    • Constructor Detail

      • PixelsWrapper

        public PixelsWrapper​(PixelsData pixels)
        Constructor of the PixelsWrapper class
        Parameters:
        pixels - The PixelData to be wrap.
    • Method Detail

      • getPlanesInfo

        public List<PlaneInfoWrapper> getPlanesInfo()
        Retrieves the planes information (which need to be loaded first).
        Returns:
        See above.
      • getPixelType

        public String getPixelType()
        Gets the pixel type.
        Returns:
        the pixel type.
      • getPixelSizeX

        public Length getPixelSizeX()
        Gets the size of a single image pixel on the X axis.
        Returns:
        Size of a pixel on the X axis.
      • getPixelSizeY

        public Length getPixelSizeY()
        Gets the size of a single image pixel on the Y axis.
        Returns:
        Size of a pixel on the Y axis.
      • getPixelSizeZ

        public Length getPixelSizeZ()
        Gets the size of a single image pixel on the Z axis.
        Returns:
        Size of a pixel on the Z axis.
      • getTimeIncrement

        public Time getTimeIncrement()
        Gets the time increment between time points.
        Returns:
        Time increment between time points.
      • getMeanTimeInterval

        public Time getMeanTimeInterval()
        Computes the mean time interval from the planes deltaTs.

        Planes information needs to be loaded first.

        Returns:
        See above.
      • getMeanExposureTime

        public Time getMeanExposureTime​(int channel)
        Computes the mean exposure time for a given channel from the planes exposureTime.

        Planes information needs to be loaded first.

        Parameters:
        channel - The channel index.
        Returns:
        See above.
      • getPositionX

        public Length getPositionX()
        Retrieves the X stage position.

        Planes information needs to be loaded first.

        Returns:
        See above.
      • getPositionY

        public Length getPositionY()
        Retrieves the Y stage position.

        Planes information needs to be loaded first.

        Returns:
        See above.
      • getPositionZ

        public Length getPositionZ()
        Retrieves the Z stage position.

        Planes information needs to be loaded first.

        Returns:
        See above.
      • getSizeX

        public int getSizeX()
        Gets the size of the image on the X axis
        Returns:
        Size of the image on the X axis.
      • getSizeY

        public int getSizeY()
        Gets the size of the image on the Y axis
        Returns:
        Size of the image on the Y axis.
      • getSizeZ

        public int getSizeZ()
        Gets the size of the image on the Z axis
        Returns:
        Size of the image on the Z axis.
      • getSizeC

        public int getSizeC()
        Gets the size of the image on the C axis
        Returns:
        Size of the image on the C axis.
      • getSizeT

        public int getSizeT()
        Gets the size of the image on the T axis
        Returns:
        Size of the image on the T axis.
      • getAllPixels

        public double[][][][][] getAllPixels​(Client client)
                                      throws AccessException,
                                             ExecutionException
        Returns an array containing the value for each voxel
        Parameters:
        client - The client handling the connection.
        Returns:
        Array containing the value for each voxel of the image.
        Throws:
        AccessException - If an error occurs while retrieving the plane data from the pixels source.
        ExecutionException - A Facility can't be retrieved or instantiated.
      • getAllPixels

        public double[][][][][] getAllPixels​(Client client,
                                             int[] xBounds,
                                             int[] yBounds,
                                             int[] cBounds,
                                             int[] zBounds,
                                             int[] tBounds)
                                      throws AccessException,
                                             ExecutionException
        Returns an array containing the value for each voxel corresponding to the bounds
        Parameters:
        client - The client handling the connection.
        xBounds - Array containing the X bounds from which the pixels should be retrieved.
        yBounds - Array containing the Y bounds from which the pixels should be retrieved.
        cBounds - Array containing the C bounds from which the pixels should be retrieved.
        zBounds - Array containing the Z bounds from which the pixels should be retrieved.
        tBounds - Array containing the T bounds from which the pixels should be retrieved.
        Returns:
        Array containing the value for each voxel of the image.
        Throws:
        AccessException - If an error occurs while retrieving the plane data from the pixels source.
        ExecutionException - A Facility can't be retrieved or instantiated.
      • getRawPixels

        public byte[][][][] getRawPixels​(Client client,
                                         int bpp)
                                  throws AccessException,
                                         ExecutionException
        Returns an array containing the raw values for each voxel for each planes
        Parameters:
        client - The client handling the connection.
        bpp - Bytes per pixels of the image.
        Returns:
        a table of bytes containing the pixel values
        Throws:
        AccessException - If an error occurs while retrieving the plane data from the pixels source.
        ExecutionException - A Facility can't be retrieved or instantiated.
      • getRawPixels

        public byte[][][][] getRawPixels​(Client client,
                                         int[] xBounds,
                                         int[] yBounds,
                                         int[] cBounds,
                                         int[] zBounds,
                                         int[] tBounds,
                                         int bpp)
                                  throws ExecutionException,
                                         AccessException
        Returns an array containing the raw values for each voxel for each plane corresponding to the bounds
        Parameters:
        client - The client handling the connection.
        xBounds - Array containing the X bounds from which the pixels should be retrieved.
        yBounds - Array containing the Y bounds from which the pixels should be retrieved.
        cBounds - Array containing the C bounds from which the pixels should be retrieved.
        zBounds - Array containing the Z bounds from which the pixels should be retrieved.
        tBounds - Array containing the T bounds from which the pixels should be retrieved.
        bpp - Bytes per pixels of the image.
        Returns:
        a table of bytes containing the pixel values
        Throws:
        AccessException - If an error occurs while retrieving the plane data from the pixels source.
        ExecutionException - A Facility can't be retrieved or instantiated.