volcart::landmarks::PlaneLandmark Class Reference

Boundless plane volume landmark. More...

#include <vc/core/landmarks/PlaneLandmark.hpp>

Inheritance diagram for volcart::landmarks::PlaneLandmark:

Collaboration diagram for volcart::landmarks::PlaneLandmark:

Public Types
using	Pointer = std::shared_ptr< PlaneLandmark >
Public Types inherited from volcart::landmarks::VolumeLandmark
using	Identifier = std::string
	Identifier type. More...
using	Point = cv::Vec3d
	3D Point type More...
using	Pointer = std::shared_ptr< VolumeLandmark >
	Pointer type. More...

Public Member Functions
	PlaneLandmark (const Identifier &uuid, const std::string &name)
	Constructor with uuid and name.
	PlaneLandmark (const Identifier &uuid, const std::string &name, const Point &center, const cv::Vec3d &normal)
	Constructor with uuid, name, center, and normal.
void	setCenter (double x, double y, double z)
	Set center of plane.
void	setCenter (const Point &values)
void	setNormal (double x, double y, double z)
	Set plane normal.
void	setNormal (const Point &values)
Point	getCenter () const
	Get center of plane.
Point	getNormal () const
	Get plane normal.
Public Member Functions inherited from volcart::landmarks::VolumeLandmark
	VolumeLandmark ()=delete
Identifier	id () const
	Get the unique identifier.
std::string	name () const
	Get human-readable landmark name.
Type	type () const
	Get the landmark type.

Static Public Member Functions
static Pointer	New (const Identifier &uuid, const std::string &name)
static Pointer	New (const Identifier &uuid, const std::string &name, const Point &center, const cv::Vec3d &normal)
Static Public Member Functions inherited from volcart::landmarks::VolumeLandmark
static void	Write (const volcart::filesystem::path &path, const Pointer &ldm)
	Write a landmark metadata file to the path provided.
static VolumeLandmark::Pointer	Read (const volcart::filesystem::path &path)
	Read a landmark metadata file from the path provided.

Private Member Functions
void	update_meta_ ()

Private Attributes
Point	center_
cv::Vec3d	normal_

Additional Inherited Members
Protected Member Functions inherited from volcart::landmarks::VolumeLandmark
	VolumeLandmark (const Identifier &uuid, const std::string &name, Type type)
Protected Attributes inherited from volcart::landmarks::VolumeLandmark
Metadata	metadata_
Type	type_

Detailed Description

Boundless plane volume landmark.

Useful for specifying a ground plane or "front cover" position.

Definition at line 16 of file PlaneLandmark.hpp.

Member Typedef Documentation

Pointer

using volcart::landmarks::PlaneLandmark::Pointer = std::shared_ptr<PlaneLandmark>

Pointer type

Definition at line 20 of file PlaneLandmark.hpp.

Member Function Documentation

New() [1/2]

static Pointer volcart::landmarks::PlaneLandmark::New ( const Identifier &  uuid, const std::string &  name  )

static

New() [2/2]

static Pointer volcart::landmarks::PlaneLandmark::New ( const Identifier &  uuid, const std::string &  name, const Point &  center, const cv::Vec3d &  normal  )

static

setCenter()

void volcart::landmarks::PlaneLandmark::setCenter

(

const Point &

values

)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

setNormal()

void volcart::landmarks::PlaneLandmark::setNormal

(

const Point &

values

)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

update_meta_()

void volcart::landmarks::PlaneLandmark::update_meta_ ( )

private

Update the metadata structure

Member Data Documentation

center_

Point volcart::landmarks::PlaneLandmark::center_

private

Plane center point

Definition at line 65 of file PlaneLandmark.hpp.

normal_

cv::Vec3d volcart::landmarks::PlaneLandmark::normal_

private

Plane normal

Definition at line 68 of file PlaneLandmark.hpp.

---

The documentation for this class was generated from the following file:

• vc/core/landmarks/PlaneLandmark.hpp