Volume Cartographer 2.27.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
volcart::landmarks::VolumeLandmark Class Reference

Base class for Volume Landmark types. More...

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

Inheritance diagram for volcart::landmarks::VolumeLandmark:
[legend]
Collaboration diagram for volcart::landmarks::VolumeLandmark:
[legend]

Public Types

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

 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 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.
 

Protected Member Functions

 VolumeLandmark (const Identifier &uuid, const std::string &name, Type type)
 

Protected Attributes

Metadata metadata_
 
Type type_
 

Detailed Description

Base class for Volume Landmark types.

Definition at line 21 of file VolumeLandmark.hpp.

Member Typedef Documentation

◆ Identifier

Identifier type.

Definition at line 28 of file VolumeLandmark.hpp.

◆ Point

3D Point type

Definition at line 31 of file VolumeLandmark.hpp.

◆ Pointer

Pointer type.

Definition at line 34 of file VolumeLandmark.hpp.

Constructor & Destructor Documentation

◆ VolumeLandmark() [1/2]

volcart::landmarks::VolumeLandmark::VolumeLandmark ( )
delete

Default constructor

◆ VolumeLandmark() [2/2]

volcart::landmarks::VolumeLandmark::VolumeLandmark ( const Identifier uuid,
const std::string &  name,
Type  type 
)
protected

Constructor with uuid, name, and type

Member Data Documentation

◆ metadata_

Metadata volcart::landmarks::VolumeLandmark::metadata_
protected

Metadata

Definition at line 57 of file VolumeLandmark.hpp.

◆ type_

Type volcart::landmarks::VolumeLandmark::type_
protected

Landmark type

Definition at line 60 of file VolumeLandmark.hpp.


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