Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: PointCloudReaders

[207:14] static extends: object

Static point cloud reader factory helpers.

Methods

  • wrap3FRGB (object Cloud, object Rgb, int Offset, int Length)

    Wraps float arrays plus RGB colors.

    • @p Cloud is a Java float[] containing xyz triples.
    • @p Rgb is a Java int[] of colors.
    • @p Offset is first point index.
    • @p Length is number of points.
    • @r A PointCloudReader.
  • wrapF32 (object Points)

    Wraps a Java list of Point3D_F32 objects.

    • @p Points is a java.util.List.
    • @r A PointCloudReader.
  • wrapF64 (object Points)

    Wraps a Java list of Point3D_F64 objects.

    • @p Points is a java.util.List.
    • @r A PointCloudReader.
  • wrapF32RGB (object Points)

    Wraps a Java list of Point3dRgbI_F32 objects.

    • @p Points is a java.util.List.
    • @r A PointCloudReader.
  • wrapF64RGB (object Points)

    Wraps a Java list of Point3dRgbI_F64 objects.

    • @p Points is a java.util.List.
    • @r A PointCloudReader.
  • wrapF32WithRgb (object Points, object Rgb)

    Wraps a Java list of Point3D_F32 objects and an int[] of RGB colors.

    • @p Points is a java.util.List.
    • @p Rgb is a Java int[].
    • @r A PointCloudReader.
  • wrapF64WithRgb (object Points, object Rgb)

    Wraps a Java list of Point3D_F64 objects and an int[] of RGB colors.

    • @p Points is a java.util.List.
    • @p Rgb is a Java int[].
    • @r A PointCloudReader.
  • wrapGeneric (object Generic, int Size)

    Wraps a custom generic point reader.

    • @p Generic is a PointCloudReader.Generic implementation.
    • @p Size is point count.
    • @r A PointCloudReader.

class: DisparityToColorPointCloud

[479:7] extends: object

DisparityToColorPointCloud wraps boofcv.alg.cloud.DisparityToColorPointCloud.

Members

  • obj

Methods

  • DisparityToColorPointCloud ()

    Creates a disparity-to-color point-cloud converter.

  • configure (...)

    Configures the converter.

    • @p Args match BoofCV configure overloads: either DisparityParameters and transform, or baseline, K, R, transform, disparityMin, disparityRange.
  • process (object Disparity, object PixelRgb, object Writer)

    Converts disparity into a point cloud.

    • @p Disparity is a gray disparity image.
    • @p PixelRgb is a ColorImage callback.
    • @p Writer is a PointCloudWriter.
  • setRegionOfInterest (int X0, int Y0, int X1, int Y1)

    Sets the region of interest.

    • @p X0 is left.
    • @p Y0 is top.
    • @p X1 is right.
    • @p Y1 is bottom.
  • clearRegionOfInterest ()

    Clears the region of interest.

class: PointCloudReader

[267:7] extends: object

PointCloudReader wraps boofcv.alg.cloud.PointCloudReader.

Members

  • obj

Methods

  • PointCloudReader (object Obj)

    Wraps a BoofCV point-cloud reader.

    • @p Obj is an existing reader object.
  • wrap3FRGB (object Cloud, object Rgb, int Offset, int Length)

    Wraps float arrays plus RGB colors.

    • @p Cloud is a Java float[] containing xyz triples.
    • @p Rgb is a Java int[] of colors.
    • @p Offset is first point index.
    • @p Length is number of points.
    • @r A PointCloudReader.
  • wrapF32 (object Points)

    Wraps a Java list of Point3D_F32 objects.

    • @p Points is a java.util.List.
    • @r A PointCloudReader.
  • wrapF64 (object Points)

    Wraps a Java list of Point3D_F64 objects.

    • @p Points is a java.util.List.
    • @r A PointCloudReader.
  • wrapF32RGB (object Points)

    Wraps a Java list of Point3dRgbI_F32 objects.

    • @p Points is a java.util.List.
    • @r A PointCloudReader.
  • wrapF64RGB (object Points)

    Wraps a Java list of Point3dRgbI_F64 objects.

    • @p Points is a java.util.List.
    • @r A PointCloudReader.
  • wrapF32WithRgb (object Points, object Rgb)

    Wraps a Java list of Point3D_F32 objects and an int[] of RGB colors.

    • @p Points is a java.util.List.
    • @p Rgb is a Java int[].
    • @r A PointCloudReader.
  • wrapF64WithRgb (object Points, object Rgb)

    Wraps a Java list of Point3D_F64 objects and an int[] of RGB colors.

    • @p Points is a java.util.List.
    • @p Rgb is a Java int[].
    • @r A PointCloudReader.
  • wrapGeneric (object Generic, int Size)

    Wraps a custom generic point reader.

    • @p Generic is a PointCloudReader.Generic implementation.
    • @p Size is point count.
    • @r A PointCloudReader.
  • size ()

    Gets the point count.

    • @r The number of points.
  • colors ()

    Gets whether color is available.

    • @r True if RGB is available.
  • get (int Index, object Storage)

    Gets a point into storage.

    • @p Index is the point index.
    • @p Storage is a Point3D_F32 or Point3D_F64 object.
  • getX (int Index)

    Gets x coordinate for a point.

    • @p Index is the point index.
    • @r The x coordinate.
  • getY (int Index)

    Gets y coordinate for a point.

    • @p Index is the point index.
    • @r The y coordinate.
  • getZ (int Index)

    Gets z coordinate for a point.

    • @p Index is the point index.
    • @r The z coordinate.
  • getRGB (int Index)

    Gets RGB for a point.

    • @p Index is the point index.
    • @r Packed RGB.

class: PointCloudIO

[18:14] static extends: object

Static wrappers for boofcv.io.points.PointCloudIO.

Methods

  • load (string Format, object InputStream, object Writer)

    Loads point cloud data.

    • @p Format is PLY, OBJ, or STL.
    • @p InputStream is a java.io.InputStream.
    • @p Writer is a PointCloudWriter or mesh target.
  • load3D32F (string Format, object InputStream, Storage = null)

    Loads 32-bit float point cloud data.

    • @p Format is PLY, OBJ, or STL.
    • @p InputStream is a java.io.InputStream.
    • @p Storage is a DogArray of Point3D_F32 or null.
    • @r A DogArray of Point3D_F32.
  • load3D64F (string Format, object InputStream, Storage = null)

    Loads 64-bit float point cloud data.

    • @p Format is PLY, OBJ, or STL.
    • @p InputStream is a java.io.InputStream.
    • @p Storage is a DogArray of Point3D_F64 or null.
    • @r A DogArray of Point3D_F64.
  • load3DRgb64F (string Format, object InputStream, Storage = null)

    Loads 64-bit float RGB point cloud data.

    • @p Format is PLY, OBJ, or STL.
    • @p InputStream is a java.io.InputStream.
    • @p Storage is a DogArray of Point3dRgbI_F64 or null.
    • @r A DogArray of Point3dRgbI_F64.
  • loadFile (object File, object Mesh)

    Loads point cloud mesh data from a file.

    • @p File is a java.io.File.
    • @p Mesh is a VertexMesh wrapper or BoofCV mesh.
  • loadObj (object File)

    Loads OBJ meshes from a file.

    • @p File is a java.io.File.
    • @r A Java map of mesh names to VertexMesh objects.
  • loadMesh (string Format, object InputStream, object Mesh)

    Loads mesh data from a stream.

    • @p Format is PLY, OBJ, or STL.
    • @p InputStream is a java.io.InputStream.
    • @p Mesh is a VertexMesh wrapper or BoofCV mesh.
  • save3D (string Format, object Reader, ...)

    Saves 3D point cloud data.

    • @p Format is PLY, OBJ, or STL.
    • @p Reader is a PointCloudReader or mesh.
    • @p Args are remaining BoofCV save arguments.
  • save3DReader (string Format, object Reader, bool SaveRgb, object OutputStream)

    Saves point cloud reader data.

    • @p Format is PLY, OBJ, or STL.
    • @p Reader is a PointCloudReader.
    • @p SaveRgb writes RGB colors when true.
    • @p OutputStream is a java.io.OutputStream.
  • save3DMesh (string Format, object Mesh, object Colors, object OutputStream)

    Saves mesh data.

    • @p Format is PLY, OBJ, or STL.
    • @p Mesh is a VertexMesh.
    • @p Colors is a DogArray_I32 of RGB colors.
    • @p OutputStream is a java.io.OutputStream.
  • save3DAccess (string Format, object Points, object Colors, int Size, bool SaveRgb, object OutputStream)

    Saves indexed point/color accessors.

    • @p Format is PLY, OBJ, or STL.
    • @p Points is an AccessPointIndex.
    • @p Colors is an AccessColorIndex or null.
    • @p Size is the point count.
    • @p SaveRgb writes RGB colors when true.
    • @p OutputStream is a java.io.OutputStream.
  • formatLookup (string Name)

    Looks up a point-cloud format enum.

    • @p Name is PLY, OBJ, or STL.
    • @r The enum Java object.

class: Point3dRgbI_F32

[117:7] extends: object

Point3dRgbI_F32 wraps boofcv.struct.Point3dRgbI_F32.

Members

  • obj

Methods

  • Point3dRgbI_F32 (X = null, Y = null, Z = null, Rgb = null)

    Creates or wraps a 32-bit RGB 3D point.

    • @p X is x or an existing point.
    • @p Y is y or RGB when X is a point.
    • @p Z is z.
    • @p Rgb is packed RGB.
  • setTo (X, Y, Z, int Rgb)

    Sets this point from coordinates and RGB.

    • @p X is x.
    • @p Y is y.
    • @p Z is z.
    • @p Rgb is packed RGB.
  • setToPoint (object Point, int Rgb)

    Sets this point from another point and RGB.

    • @p Point is a Point3D_F32-compatible object.
    • @p Rgb is packed RGB.
  • get (string Name)

    Gets a coordinate or color.

    • @p Name is x, y, z, or rgb.
    • @r The requested value.
  • setRgb (int Rgb)

    Sets RGB color.

    • @p Rgb is packed RGB.
  • getRgb ()

    Gets RGB color.

    • @r Packed RGB.

class: PointCloudFormat

[6:14] static extends: object

PointCloudFormat wraps boofcv.io.points.PointCloudIO.Format.

Methods

  • valueOf (string Name)

    Looks up a point-cloud file format.

    • @p Name is PLY, OBJ, or STL.
    • @r The enum Java object.

class: PointCloudWriters

[373:14] static extends: object

Static point cloud writer factory helpers.

Methods

  • wrapF32 (object Points)

    Wraps a DogArray of Point3D_F32.

    • @p Points is a DogArray.
    • @r A PointCloudWriter.
  • wrapF64 (object Points)

    Wraps a DogArray of Point3D_F64.

    • @p Points is a DogArray.
    • @r A PointCloudWriter.
  • wrapF64WithRgb (object Points, object Rgb)

    Wraps a DogArray of Point3D_F64 and a DogArray_I32 of RGB colors.

    • @p Points is a DogArray.
    • @p Rgb is a DogArray_I32.
    • @r A PointCloudWriter.
  • wrapF32RGB (object Points)

    Wraps a DogArray of Point3dRgbI_F32.

    • @p Points is a DogArray.
    • @r A PointCloudWriter.
  • wrapF64RGB (object Points)

    Wraps a DogArray of Point3dRgbI_F64.

    • @p Points is a DogArray.
    • @r A PointCloudWriter.

class: Point3dRgbI_F64

[162:7] extends: object

Point3dRgbI_F64 wraps boofcv.struct.Point3dRgbI_F64.

Members

  • obj

Methods

  • Point3dRgbI_F64 (X = null, Y = null, Z = null, Rgb = null)

    Creates or wraps a 64-bit RGB 3D point.

    • @p X is x or an existing point.
    • @p Y is y or RGB when X is a point.
    • @p Z is z.
    • @p Rgb is packed RGB.
  • setTo (X, Y, Z, int Rgb)

    Sets this point from coordinates and RGB.

    • @p X is x.
    • @p Y is y.
    • @p Z is z.
    • @p Rgb is packed RGB.
  • setToPoint (object Point, int Rgb)

    Sets this point from another point and RGB.

    • @p Point is a Point3D_F64-compatible object.
    • @p Rgb is packed RGB.
  • get (string Name)

    Gets a coordinate or color.

    • @p Name is x, y, z, or rgb.
    • @r The requested value.
  • setRgb (int Rgb)

    Sets RGB color.

    • @p Rgb is packed RGB.
  • getRgb ()

    Gets RGB color.

    • @r Packed RGB.

class: PointCloudWriter

[410:7] extends: object

PointCloudWriter wraps boofcv.alg.cloud.PointCloudWriter.

Members

  • obj

Methods

  • PointCloudWriter (object Obj)

    Wraps a BoofCV point-cloud writer.

    • @p Obj is an existing writer object.
  • wrapF32 (object Points)

    Wraps a DogArray of Point3D_F32.

    • @p Points is a DogArray.
    • @r A PointCloudWriter.
  • wrapF64 (object Points)

    Wraps a DogArray of Point3D_F64.

    • @p Points is a DogArray.
    • @r A PointCloudWriter.
  • wrapF64WithRgb (object Points, object Rgb)

    Wraps a DogArray of Point3D_F64 and a DogArray_I32 of RGB colors.

    • @p Points is a DogArray.
    • @p Rgb is a DogArray_I32.
    • @r A PointCloudWriter.
  • wrapF32RGB (object Points)

    Wraps a DogArray of Point3dRgbI_F32.

    • @p Points is a DogArray.
    • @r A PointCloudWriter.
  • wrapF64RGB (object Points)

    Wraps a DogArray of Point3dRgbI_F64.

    • @p Points is a DogArray.
    • @r A PointCloudWriter.
  • initialize (int Size, bool HasColor)

    Initializes writing.

    • @p Size is the expected point count.
    • @p HasColor is true when RGB is provided.
  • startPoint ()

    Starts one point.

  • location (double X, double Y, double Z)

    Sets current point location.

    • @p X is x.
    • @p Y is y.
    • @p Z is z.
  • color (int Rgb)

    Sets current point color.

    • @p Rgb is packed RGB.
  • stopPoint ()

    Finishes one point.