class: UtilImageIO

[6:14] static extends: object

Static wrappers for BoofCV image and general I/O helpers.

Methods

• loadImage (string Path)

  Loads an image file as a Java BufferedImage.

  • @p Path is the image file path.
  • @r An AussomJavaObject wrapping java.awt.image.BufferedImage, or null when BoofCV cannot load the image.

• loadImageNotNull (string Path)

  Loads an image file as a Java BufferedImage and throws if it cannot be loaded.

  • @p Path is the image file path.
  • @r An AussomJavaObject wrapping java.awt.image.BufferedImage.

• loadImageGray (string Path, string ImageClassName)

  Loads an image file as a BoofCV gray image.

  • @p Path is the image file path.
  • @p ImageClassName is a full gray image class name or one of u8, grayu8, s8, grays8, u16, grayu16, s16, grays16, s32, grays32, s64, grays64, f32, grayf32, f64, or grayf64.
  • @r The matching Aussom gray image wrapper.

• saveImage (object Image, string Path)

  Saves an image to a file.

  • @p Image is a Java BufferedImage, BoofCV ImageBase wrapper, or AussomJavaObject.
  • @p Path is the output image file path. BoofCV chooses the format from common suffixes such as png, jpg, jpeg, bmp, gif, pgm, and ppm.

• loadPgmU8 (string Path)

  Loads a PGM file as a GrayU8 image.

  • @p Path is the PGM file path.
  • @r A GrayU8 wrapper.

• savePgm (object GrayU8Image, string Path)

  Saves a GrayU8 image as a PGM file.

  • @p GrayU8Image is a GrayU8 wrapper or compatible Java object.
  • @p Path is the output PGM file path.

• loadPpm (string Path)

  Loads a PPM file as a Planar GrayU8 image.

  • @p Path is the PPM file path.
  • @r A Planar wrapper.

• savePpm (object PlanarImage, string Path)

  Saves a Planar GrayU8 image as a PPM file.

  • @p PlanarImage is a Planar GrayU8 wrapper or compatible Java object.
  • @p Path is the output PPM file path.

class: UtilIO

[86:14] static extends: object

Static wrappers for boofcv.io.UtilIO.

Methods

• pathExample (string Name)

  Returns the path to a BoofCV example resource.

  • @p Name is the example resource name or relative path.
  • @r A string path.

• fileExample (string Name)

  Returns the file for a BoofCV example resource.

  • @p Name is the example resource name or relative path.
  • @r An AussomJavaObject wrapping java.io.File.

• loadConfig (string Path)

  Loads a BoofCV YAML configuration file.

  • @p Path is the configuration file path.
  • @r The loaded BoofCV configuration object.