Module imagingbook.common
Package imagingbook.common.image.access

Class ScalarAccessor

java.lang.Object
imagingbook.common.image.access.ImageAccessor
imagingbook.common.image.access.ScalarAccessor
Direct Known Subclasses:
ByteAccessor, FloatAccessor, ShortAccessor
public abstract class ScalarAccessor extends ImageAccessor
The common (abstract) super-class for all image accessors to scalar-valued images. It inherits all methods from ImageAccessor but adds the methods getVal(int, int), getVal(double, double) and setVal(int, int, float) for reading and writing scalar-valued pixel data.

  • Method Details

    • create

      public static ScalarAccessor create(ImageProcessor ip, OutOfBoundsStrategy obs, InterpolationMethod ipm)
      Creates a new image accessor of general type ScalarAccessor. The conrete type of the returned instance depends on the specified image, i.e., ByteAccessor for ByteProcessor, ShortAccessor for ShortProcessor, FloatAccessor for FloatProcessor.
      Parameters:
      ip - the image to be accessed
      obs - the out-of-bounds strategy to be used (use null for default settings)
      ipm - the interpolation method to be used (use null for default settings)
      Returns:
      a new image accessor

    • getDepth

      public int getDepth()
      Description copied from class: ImageAccessor
      Returns the depth (number of components) of this image accessor. 1 is returned if the image is scalar-valued.
      Specified by:
      getDepth in class ImageAccessor
      Returns:
      the image depth.

    • getComponentAccessor

      public ScalarAccessor getComponentAccessor(int k)
      Description copied from class: ImageAccessor
      Returns the ImageAccessor for the k-th component; the result is a sub-type of ScalarAccessor. In the case of a scalar-valued image, THIS object is returned.
      Specified by:
      getComponentAccessor in class ImageAccessor
      Parameters:
      k - the component index
      Returns:
      the component accessor.

    • getVal

      public abstract float getVal(int u, int v)
      Reads and returns the scalar pixel value for the given image position. The value returned for coordinates outside the image boundaries depends on the OutOfBoundsStrategy specified for this ImageAccessor.
      Parameters:
      u - the x-coordinate
      v - the y-coordinate
      Returns:
      the pixel value (float)

    • getVal

      public float getVal(int u, int v, int k)
      Description copied from class: ImageAccessor
      Returns the value of the pixel's k-th component at the specified position. If the associated image is scalar-valued, this is equivalent to component 0. See also ImageAccessor.getDepth().
      Specified by:
      getVal in class ImageAccessor
      Parameters:
      u - the x-coordinate
      v - the y-coordinate
      k - the component index
      Returns:
      the component value (float)

    • getVal

      public float getVal(double x, double y, int k)
      Description copied from class: ImageAccessor
      Returns the interpolated value of the pixel's k-th component at the specified position. If the associated image is scalar-valued, this is equivalent to component 0. See also ImageAccessor.getDepth().
      Specified by:
      getVal in class ImageAccessor
      Parameters:
      x - the x-coordinate
      y - the y-coordinate
      k - the component index
      Returns:
      the interpolated component value (float[])

    • getVal

      public float getVal(double x, double y)
      Reads and returns the interpolated scalar pixel value for the given image position. The value returned for coordinates outside the image boundaries depends on the OutOfBoundsStrategy specified for this ImageAccessor.
      Parameters:
      x - the x-coordinate
      y - the y-coordinate
      Returns:
      the pixel value (float)

    • setVal

      public abstract void setVal(int u, int v, float val)
      Writes a scalar pixel value to the given image position. An exception is thrown if u, v coordinates are outside the image.
      Parameters:
      u - the x-coordinate
      v - the y-coordinate
      val - the new pixel value (float)

    • setVal

      public void setVal(int u, int v, int k, float val)
      Description copied from class: ImageAccessor
      Sets the value of the pixel's k-th component at the specified position. If the associated image is scalar-valued, this is equivalent to component 0. See also ImageAccessor.getDepth().
      Specified by:
      setVal in class ImageAccessor
      Parameters:
      u - the x-coordinate
      v - the y-coordinate
      k - the component index
      val - the new component value

    • getPix

      public float[] getPix(int u, int v)
      Description copied from class: ImageAccessor
      Returns the pixel value for the specified floating-point position as a float[] with either 1 element for scalar-valued images and or more elements (e.g., 3 for for RGB images).
      Specified by:
      getPix in class ImageAccessor
      Parameters:
      u - the x-coordinate
      v - the y-coordinate
      Returns:
      the pixel value (float[])

    • getPix

      public float[] getPix(double x, double y)
      Description copied from class: ImageAccessor
      Returns the interpolated pixel value for the specified floating-point position as a float[] with either 1 element for scalar-valued images and or more elements (e.g., 3 for for RGB images). Interpolation is used non-integer coordinates.
      Specified by:
      getPix in class ImageAccessor
      Parameters:
      x - the x-coordinate
      y - the y-coordinate
      Returns:
      the interpolated pixel value (float[])

    • setPix

      public void setPix(int u, int v, float[] pix)
      Description copied from class: ImageAccessor
      Sets the pixel value at the specified integer position. The new value must be provided as float[] with 1 element for scalar-valued images or 3 elements for RGB images.
      Specified by:
      setPix in class ImageAccessor
      Parameters:
      u - the x-coordinate
      v - the y-coordinate
      pix - the new pixel value (float[])