Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: InterleavedU8

[1093:7] extends: object

InterleavedU8 wraps boofcv.struct.image.InterleavedU8.

Members

  • obj

Methods

  • InterleavedU8 (int Width = 0, int Height = 0, int NumBands = 1, object Obj = null)

    Creates an unsigned 8-bit interleaved image or wraps an existing Java object.

    • @p Width is the image width in pixels.
    • @p Height is the image height in pixels.
    • @p NumBands is the number of bands per pixel.
    • @p Obj is an existing AussomJavaObject or wrapper, or null to create a new image.
  • getWidth ()

    Gets the image width.

    • @r The image width in pixels.
  • getHeight ()

    Gets the image height.

    • @r The image height in pixels.
  • getNumBands ()

    Gets the number of bands per pixel.

    • @r The number of bands.
  • getImageType ()

    Gets the BoofCV image type.

    • @r An AussomJavaObject wrapping ImageType.
  • get (int X, int Y, int Band)

    Gets one band from one pixel.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Band is the band index.
    • @r The band value.
  • set (int X, int Y, int Band, int Value)

    Sets one band on one pixel.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Band is the band index.
    • @p Value is the band value.
  • reshape (int Width, int Height, int NumBands)

    Reshapes this image.

    • @p Width is the new width in pixels.
    • @p Height is the new height in pixels.
    • @p NumBands is the new number of bands.
  • clone ()

    Clones this image.

    • @r A new InterleavedU8 wrapper around the cloned image.

class: ImageTypes

[1310:14] static extends: object

ImageTypes exposes static factory methods for boofcv.struct.image.ImageType.

Methods

  • single (string ImageClassName)

    Creates a single-band ImageType.

    • @p ImageClassName is a full gray image class name or supported short image name.
    • @r An ImageType wrapper.
  • pl (int NumBands, string ImageClassName)

    Creates a planar ImageType.

    • @p NumBands is the number of bands.
    • @p ImageClassName is a full gray image class name or supported short image name.
    • @r An ImageType wrapper.
  • il (int NumBands, string ImageClassName)

    Creates an interleaved ImageType.

    • @p NumBands is the number of bands.
    • @p ImageClassName is a full interleaved image class name or supported short image name.
    • @r An ImageType wrapper.

class: boofcv_images

[6:14] static extends: object

Shared image wrapper helper methods.

Methods

  • grayObj (string ClassName, int Width, int Height, object Obj = null)

    Creates a Java BoofCV image object or returns an existing wrapped object.

    • @p ClassName is the full Java image class name.
    • @p Width is the image width in pixels.
    • @p Height is the image height in pixels.
    • @p Obj is an existing AussomJavaObject or wrapper, or null to create a new image.
    • @r An AussomJavaObject containing the BoofCV image.
  • interleavedObj (string ClassName, int Width, int Height, int NumBands, object Obj = null)

    Creates a Java BoofCV interleaved image object or returns an existing wrapped object.

    • @p ClassName is the full Java image class name.
    • @p Width is the image width in pixels.
    • @p Height is the image height in pixels.
    • @p NumBands is the number of bands per pixel.
    • @p Obj is an existing AussomJavaObject or wrapper, or null to create a new image.
    • @r An AussomJavaObject containing the BoofCV image.
  • wrapImage (string ClassName, object Obj)

    Wraps a Java BoofCV image object in the matching Aussom image wrapper.

    • @p ClassName is a full BoofCV image class name or one of u8, grayu8, s8, grays8, u16, grayu16, s16, grays16, s32, grays32, s64, grays64, f32, grayf32, f64, grayf64, interleaved_u8, interleavedu8, interleaved_f32, or interleavedf32.
    • @p Obj is an existing BoofCV image Java object or wrapper.
    • @r The matching Aussom image wrapper.

class: ImageType

[1277:7] extends: object

ImageType wraps boofcv.struct.image.ImageType.

Members

  • obj

Methods

  • ImageType (object Obj = null)

    Wraps an existing BoofCV ImageType object.

    • @p Obj is an existing AussomJavaObject or wrapper.
  • getFamily ()

    Gets the image family.

    • @r An AussomJavaObject wrapping ImageType.Family.
  • getNumBands ()

    Gets the number of bands.

    • @r The number of bands.
  • getDataType ()

    Gets the image data type.

    • @r An AussomJavaObject wrapping ImageDataType.

class: GrayF64

[893:7] extends: object

GrayF64 wraps boofcv.struct.image.GrayF64.

Members

  • obj

Methods

  • GrayF64 (int Width = 0, int Height = 0, object Obj = null)

    Creates a 64-bit floating point gray image or wraps an existing Java object.

    • @p Width is the image width in pixels.
    • @p Height is the image height in pixels.
    • @p Obj is an existing AussomJavaObject or wrapper, or null to create a new image.
  • getWidth ()

    Gets the image width.

    • @r The image width in pixels.
  • getHeight ()

    Gets the image height.

    • @r The image height in pixels.
  • get (int X, int Y)

    Gets a pixel value with bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @r The pixel value.
  • set (int X, int Y, double Value)

    Sets a pixel value with bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Value is the pixel value.
  • unsafe_get (int X, int Y)

    Gets a pixel value without bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @r The pixel value.
  • unsafe_set (int X, int Y, double Value)

    Sets a pixel value without bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Value is the pixel value.
  • reshape (int Width, int Height)

    Reshapes this image.

    • @p Width is the new width in pixels.
    • @p Height is the new height in pixels.
  • subimage (int X0, int Y0, int X1, int Y1)

    Creates a subimage view.

    • @p X0 is the inclusive lower x coordinate.
    • @p Y0 is the inclusive lower y coordinate.
    • @p X1 is the exclusive upper x coordinate.
    • @p Y1 is the exclusive upper y coordinate.
    • @r A GrayF64 wrapper around the subimage view.
  • setTo (object Other)

    Copies another image into this image.

    • @p Other is another GrayF64-compatible image.
    • @r This image.
  • clone ()

    Clones this image.

    • @r A new GrayF64 wrapper around the cloned image.
  • getDataType ()

    Gets the BoofCV image data type.

    • @r An AussomJavaObject wrapping ImageDataType.

class: GrayS8

[156:7] extends: object

GrayS8 wraps boofcv.struct.image.GrayS8.

Members

  • obj

Methods

  • GrayS8 (int Width = 0, int Height = 0, object Obj = null)

    Creates a signed 8-bit gray image or wraps an existing Java object.

    • @p Width is the image width in pixels.
    • @p Height is the image height in pixels.
    • @p Obj is an existing AussomJavaObject or wrapper, or null to create a new image.
  • getWidth ()

    Gets the image width.

    • @r The image width in pixels.
  • getHeight ()

    Gets the image height.

    • @r The image height in pixels.
  • get (int X, int Y)

    Gets a pixel value with bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @r The pixel value.
  • set (int X, int Y, int Value)

    Sets a pixel value with bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Value is the pixel value.
  • unsafe_get (int X, int Y)

    Gets a pixel value without bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @r The pixel value.
  • unsafe_set (int X, int Y, int Value)

    Sets a pixel value without bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Value is the pixel value.
  • reshape (int Width, int Height)

    Reshapes this image.

    • @p Width is the new width in pixels.
    • @p Height is the new height in pixels.
  • subimage (int X0, int Y0, int X1, int Y1)

    Creates a subimage view.

    • @p X0 is the inclusive lower x coordinate.
    • @p Y0 is the inclusive lower y coordinate.
    • @p X1 is the exclusive upper x coordinate.
    • @p Y1 is the exclusive upper y coordinate.
    • @r A GrayS8 wrapper around the subimage view.
  • setTo (object Other)

    Copies another image into this image.

    • @p Other is another GrayS8-compatible image.
    • @r This image.
  • clone ()

    Clones this image.

    • @r A new GrayS8 wrapper around the cloned image.
  • getDataType ()

    Gets the BoofCV image data type.

    • @r An AussomJavaObject wrapping ImageDataType.

class: Planar

[1016:7] extends: object

Planar wraps boofcv.struct.image.Planar.

Members

  • obj

Methods

  • Planar (string BandTypeName = "u8", int Width = 0, int Height = 0, int NumBands = 3, object Obj = null)

    Creates a planar image or wraps an existing Java object.

    • @p BandTypeName is a full gray image class name or supported short image name.
    • @p Width is the image width in pixels.
    • @p Height is the image height in pixels.
    • @p NumBands is the number of bands.
    • @p Obj is an existing AussomJavaObject or wrapper, or null to create a new image.
  • getNumBands ()

    Gets the number of image bands.

    • @r The number of bands.
  • getBand (int Index)

    Gets a band image.

    • @p Index is the band index.
    • @r An AussomJavaObject for the band image.
  • setBand (int Index, object Image)

    Sets a band image.

    • @p Index is the band index.
    • @p Image is a BoofCV gray image wrapper or Java object.
  • getWidth ()

    Gets the image width.

    • @r The image width in pixels.
  • getHeight ()

    Gets the image height.

    • @r The image height in pixels.
  • reshape (int Width, int Height, int NumBands)

    Reshapes this image.

    • @p Width is the new width in pixels.
    • @p Height is the new height in pixels.
    • @p NumBands is the new number of bands.
  • clone ()

    Clones this image.

    • @r A new Planar wrapper around the cloned image.

class: GrayU8

[59:7] extends: object

GrayU8 wraps boofcv.struct.image.GrayU8.

Members

  • obj

Methods

  • GrayU8 (int Width = 0, int Height = 0, object Obj = null)

    Creates an unsigned 8-bit gray image or wraps an existing Java object.

    • @p Width is the image width in pixels.
    • @p Height is the image height in pixels.
    • @p Obj is an existing AussomJavaObject or wrapper, or null to create a new image.
  • getWidth ()

    Gets the image width.

    • @r The image width in pixels.
  • getHeight ()

    Gets the image height.

    • @r The image height in pixels.
  • get (int X, int Y)

    Gets a pixel value with bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @r The pixel value.
  • set (int X, int Y, int Value)

    Sets a pixel value with bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Value is the pixel value.
  • unsafe_get (int X, int Y)

    Gets a pixel value without bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @r The pixel value.
  • unsafe_set (int X, int Y, int Value)

    Sets a pixel value without bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Value is the pixel value.
  • reshape (int Width, int Height)

    Reshapes this image.

    • @p Width is the new width in pixels.
    • @p Height is the new height in pixels.
  • subimage (int X0, int Y0, int X1, int Y1)

    Creates a subimage view.

    • @p X0 is the inclusive lower x coordinate.
    • @p Y0 is the inclusive lower y coordinate.
    • @p X1 is the exclusive upper x coordinate.
    • @p Y1 is the exclusive upper y coordinate.
    • @r A GrayU8 wrapper around the subimage view.
  • setTo (object Other)

    Copies another image into this image.

    • @p Other is another GrayU8-compatible image.
    • @r This image.
  • clone ()

    Clones this image.

    • @r A new GrayU8 wrapper around the cloned image.
  • getDataType ()

    Gets the BoofCV image data type.

    • @r An AussomJavaObject wrapping ImageDataType.

class: GrayS64

[647:7] extends: object

GrayS64 wraps boofcv.struct.image.GrayS64.

Members

  • obj

Methods

  • GrayS64 (int Width = 0, int Height = 0, object Obj = null)

    Creates a signed 64-bit gray image or wraps an existing Java object.

    • @p Width is the image width in pixels.
    • @p Height is the image height in pixels.
    • @p Obj is an existing AussomJavaObject or wrapper, or null to create a new image.
  • getWidth ()

    Gets the image width.

    • @r The image width in pixels.
  • getHeight ()

    Gets the image height.

    • @r The image height in pixels.
  • get (int X, int Y)

    Gets a pixel value with bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @r The pixel value.
  • set (int X, int Y, int Value)

    Sets a pixel value with bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Value is the pixel value.
  • unsafe_get (int X, int Y)

    Gets a pixel value without bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @r The pixel value.
  • unsafe_set (int X, int Y, int Value)

    Sets a pixel value without bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Value is the pixel value.
  • reshape (int Width, int Height)

    Reshapes this image.

    • @p Width is the new width in pixels.
    • @p Height is the new height in pixels.
  • subimage (int X0, int Y0, int X1, int Y1)

    Creates a subimage view.

    • @p X0 is the inclusive lower x coordinate.
    • @p Y0 is the inclusive lower y coordinate.
    • @p X1 is the exclusive upper x coordinate.
    • @p Y1 is the exclusive upper y coordinate.
    • @r A GrayS64 wrapper around the subimage view.
  • setTo (object Other)

    Copies another image into this image.

    • @p Other is another GrayS64-compatible image.
    • @r This image.
  • clone ()

    Clones this image.

    • @r A new GrayS64 wrapper around the cloned image.
  • getDataType ()

    Gets the BoofCV image data type.

    • @r An AussomJavaObject wrapping ImageDataType.

class: GrayU16

[278:7] extends: object

GrayU16 wraps boofcv.struct.image.GrayU16.

Members

  • obj

Methods

  • GrayU16 (int Width = 0, int Height = 0, object Obj = null)

    Creates an unsigned 16-bit gray image or wraps an existing Java object.

    • @p Width is the image width in pixels.
    • @p Height is the image height in pixels.
    • @p Obj is an existing AussomJavaObject or wrapper, or null to create a new image.
  • getWidth ()

    Gets the image width.

    • @r The image width in pixels.
  • getHeight ()

    Gets the image height.

    • @r The image height in pixels.
  • get (int X, int Y)

    Gets a pixel value with bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @r The pixel value.
  • set (int X, int Y, int Value)

    Sets a pixel value with bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Value is the pixel value.
  • unsafe_get (int X, int Y)

    Gets a pixel value without bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @r The pixel value.
  • unsafe_set (int X, int Y, int Value)

    Sets a pixel value without bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Value is the pixel value.
  • reshape (int Width, int Height)

    Reshapes this image.

    • @p Width is the new width in pixels.
    • @p Height is the new height in pixels.
  • subimage (int X0, int Y0, int X1, int Y1)

    Creates a subimage view.

    • @p X0 is the inclusive lower x coordinate.
    • @p Y0 is the inclusive lower y coordinate.
    • @p X1 is the exclusive upper x coordinate.
    • @p Y1 is the exclusive upper y coordinate.
    • @r A GrayU16 wrapper around the subimage view.
  • setTo (object Other)

    Copies another image into this image.

    • @p Other is another GrayU16-compatible image.
    • @r This image.
  • clone ()

    Clones this image.

    • @r A new GrayU16 wrapper around the cloned image.
  • getDataType ()

    Gets the BoofCV image data type.

    • @r An AussomJavaObject wrapping ImageDataType.

class: GrayS16

[401:7] extends: object

GrayS16 wraps boofcv.struct.image.GrayS16.

Members

  • obj

Methods

  • GrayS16 (int Width = 0, int Height = 0, object Obj = null)

    Creates a signed 16-bit gray image or wraps an existing Java object.

    • @p Width is the image width in pixels.
    • @p Height is the image height in pixels.
    • @p Obj is an existing AussomJavaObject or wrapper, or null to create a new image.
  • getWidth ()

    Gets the image width.

    • @r The image width in pixels.
  • getHeight ()

    Gets the image height.

    • @r The image height in pixels.
  • get (int X, int Y)

    Gets a pixel value with bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @r The pixel value.
  • set (int X, int Y, int Value)

    Sets a pixel value with bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Value is the pixel value.
  • unsafe_get (int X, int Y)

    Gets a pixel value without bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @r The pixel value.
  • unsafe_set (int X, int Y, int Value)

    Sets a pixel value without bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Value is the pixel value.
  • reshape (int Width, int Height)

    Reshapes this image.

    • @p Width is the new width in pixels.
    • @p Height is the new height in pixels.
  • subimage (int X0, int Y0, int X1, int Y1)

    Creates a subimage view.

    • @p X0 is the inclusive lower x coordinate.
    • @p Y0 is the inclusive lower y coordinate.
    • @p X1 is the exclusive upper x coordinate.
    • @p Y1 is the exclusive upper y coordinate.
    • @r A GrayS16 wrapper around the subimage view.
  • setTo (object Other)

    Copies another image into this image.

    • @p Other is another GrayS16-compatible image.
    • @r This image.
  • clone ()

    Clones this image.

    • @r A new GrayS16 wrapper around the cloned image.
  • getDataType ()

    Gets the BoofCV image data type.

    • @r An AussomJavaObject wrapping ImageDataType.

class: GrayF32

[770:7] extends: object

GrayF32 wraps boofcv.struct.image.GrayF32.

Members

  • obj

Methods

  • GrayF32 (int Width = 0, int Height = 0, object Obj = null)

    Creates a 32-bit floating point gray image or wraps an existing Java object.

    • @p Width is the image width in pixels.
    • @p Height is the image height in pixels.
    • @p Obj is an existing AussomJavaObject or wrapper, or null to create a new image.
  • getWidth ()

    Gets the image width.

    • @r The image width in pixels.
  • getHeight ()

    Gets the image height.

    • @r The image height in pixels.
  • get (int X, int Y)

    Gets a pixel value with bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @r The pixel value.
  • set (int X, int Y, double Value)

    Sets a pixel value with bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Value is the pixel value.
  • unsafe_get (int X, int Y)

    Gets a pixel value without bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @r The pixel value.
  • unsafe_set (int X, int Y, double Value)

    Sets a pixel value without bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Value is the pixel value.
  • reshape (int Width, int Height)

    Reshapes this image.

    • @p Width is the new width in pixels.
    • @p Height is the new height in pixels.
  • subimage (int X0, int Y0, int X1, int Y1)

    Creates a subimage view.

    • @p X0 is the inclusive lower x coordinate.
    • @p Y0 is the inclusive lower y coordinate.
    • @p X1 is the exclusive upper x coordinate.
    • @p Y1 is the exclusive upper y coordinate.
    • @r A GrayF32 wrapper around the subimage view.
  • setTo (object Other)

    Copies another image into this image.

    • @p Other is another GrayF32-compatible image.
    • @r This image.
  • clone ()

    Clones this image.

    • @r A new GrayF32 wrapper around the cloned image.
  • getDataType ()

    Gets the BoofCV image data type.

    • @r An AussomJavaObject wrapping ImageDataType.

class: InterleavedF32

[1185:7] extends: object

InterleavedF32 wraps boofcv.struct.image.InterleavedF32.

Members

  • obj

Methods

  • InterleavedF32 (int Width = 0, int Height = 0, int NumBands = 1, object Obj = null)

    Creates a 32-bit floating point interleaved image or wraps an existing Java object.

    • @p Width is the image width in pixels.
    • @p Height is the image height in pixels.
    • @p NumBands is the number of bands per pixel.
    • @p Obj is an existing AussomJavaObject or wrapper, or null to create a new image.
  • getWidth ()

    Gets the image width.

    • @r The image width in pixels.
  • getHeight ()

    Gets the image height.

    • @r The image height in pixels.
  • getNumBands ()

    Gets the number of bands per pixel.

    • @r The number of bands.
  • getImageType ()

    Gets the BoofCV image type.

    • @r An AussomJavaObject wrapping ImageType.
  • get (int X, int Y, int Band)

    Gets one band from one pixel.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Band is the band index.
    • @r The band value.
  • set (int X, int Y, int Band, double Value)

    Sets one band on one pixel.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Band is the band index.
    • @p Value is the band value.
  • reshape (int Width, int Height, int NumBands)

    Reshapes this image.

    • @p Width is the new width in pixels.
    • @p Height is the new height in pixels.
    • @p NumBands is the new number of bands.
  • clone ()

    Clones this image.

    • @r A new InterleavedF32 wrapper around the cloned image.

class: GrayS32

[524:7] extends: object

GrayS32 wraps boofcv.struct.image.GrayS32.

Members

  • obj

Methods

  • GrayS32 (int Width = 0, int Height = 0, object Obj = null)

    Creates a signed 32-bit gray image or wraps an existing Java object.

    • @p Width is the image width in pixels.
    • @p Height is the image height in pixels.
    • @p Obj is an existing AussomJavaObject or wrapper, or null to create a new image.
  • getWidth ()

    Gets the image width.

    • @r The image width in pixels.
  • getHeight ()

    Gets the image height.

    • @r The image height in pixels.
  • get (int X, int Y)

    Gets a pixel value with bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @r The pixel value.
  • set (int X, int Y, int Value)

    Sets a pixel value with bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Value is the pixel value.
  • unsafe_get (int X, int Y)

    Gets a pixel value without bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @r The pixel value.
  • unsafe_set (int X, int Y, int Value)

    Sets a pixel value without bounds checks.

    • @p X is the x coordinate.
    • @p Y is the y coordinate.
    • @p Value is the pixel value.
  • reshape (int Width, int Height)

    Reshapes this image.

    • @p Width is the new width in pixels.
    • @p Height is the new height in pixels.
  • subimage (int X0, int Y0, int X1, int Y1)

    Creates a subimage view.

    • @p X0 is the inclusive lower x coordinate.
    • @p Y0 is the inclusive lower y coordinate.
    • @p X1 is the exclusive upper x coordinate.
    • @p Y1 is the exclusive upper y coordinate.
    • @r A GrayS32 wrapper around the subimage view.
  • setTo (object Other)

    Copies another image into this image.

    • @p Other is another GrayS32-compatible image.
    • @r This image.
  • clone ()

    Clones this image.

    • @r A new GrayS32 wrapper around the cloned image.
  • getDataType ()

    Gets the BoofCV image data type.

    • @r An AussomJavaObject wrapping ImageDataType.