volcart::landmarks::PointLandmark Class Reference

3D Point volume landmark More...

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

Inheritance diagram for volcart::landmarks::PointLandmark:

Collaboration diagram for volcart::landmarks::PointLandmark:

Public Types
using	Pointer = std::shared_ptr< PointLandmark >
	Pointer type. More...
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
	PointLandmark (const Identifier &uuid, const std::string &name)
	Constructor with uuid and name.
	PointLandmark (const Identifier &uuid, const std::string &name, const Point &pos)
	Constructor with uuid, name, and position.
void	setPosition (const Point &pos)
	Set landmark position.
void	setPosition (double x, double y, double z)
Point	getPosition () const
	Get landmark position.
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)
	Constructor with uuid and name. More...
static Pointer	New (const Identifier &uuid, const std::string &name, const Point &position)
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	position_

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

3D Point volume landmark

Useful for specifying the location of features-of-interest.

Definition at line 17 of file PointLandmark.hpp.

Member Typedef Documentation

Pointer

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

Pointer type.

Definition at line 21 of file PointLandmark.hpp.

Member Function Documentation

New() [1/2]

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

static

Constructor with uuid and name.

New() [2/2]

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

static

setPosition()

void volcart::landmarks::PointLandmark::setPosition	(	double	x,
		double	y,
		double	z
	)

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::PointLandmark::update_meta_ ( )

private

Update the metadata structure

Member Data Documentation

position_

Point volcart::landmarks::PointLandmark::position_

private

Landmark position

Definition at line 49 of file PointLandmark.hpp.

---

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

• vc/core/landmarks/PointLandmark.hpp