Volume Cartographer 2.27.0
Public Member Functions | Public Attributes | Private Attributes | List of all members
volcart::VolumePkgPropertiesNode Class Reference

Retrieve VolumePkg properties (e.g. name, version, etc.) More...

#include <vc/graph/core.hpp>

Inheritance diagram for volcart::VolumePkgPropertiesNode:
[legend]
Collaboration diagram for volcart::VolumePkgPropertiesNode:
[legend]

Public Member Functions

 VolumePkgPropertiesNode ()
 

Public Attributes

smgl::InputPort< VolumePkg::Pointervolpkg
 Input VolumePkg. More...
 
smgl::OutputPort< std::string > name
 Returns the identifying name of the VolumePkg. More...
 
smgl::OutputPort< int > version
 Returns the VolumePkg version. More...
 
smgl::OutputPort< double > materialThickness
 Returns the approx. thickness of a material layer in microns (um). More...
 

Private Attributes

VolumePkg::Pointer vpkg_ {nullptr}
 

Detailed Description

Retrieve VolumePkg properties (e.g. name, version, etc.)

Definition at line 63 of file core.hpp.

Constructor & Destructor Documentation

◆ VolumePkgPropertiesNode()

volcart::VolumePkgPropertiesNode::VolumePkgPropertiesNode ( )

Constructor

Member Data Documentation

◆ materialThickness

smgl::OutputPort<double> volcart::VolumePkgPropertiesNode::materialThickness

Returns the approx. thickness of a material layer in microns (um).

This value is approximated by the user when the VolumePkg is created. This is an intrinsic property of the scanned object and is therefore indepedent of scan resolution. The material thickness in microns can be used to estimate the material thickness in voxels for scans of any resolution.

\[
  \frac{\mbox{Material Thickness }(um)}{\mbox{Voxel Size }(um)}
  = \mbox{Material Thickness }(voxels)
\]

Returns
Layer thickness, measured in microns (um).

Definition at line 77 of file core.hpp.

◆ name

smgl::OutputPort<std::string> volcart::VolumePkgPropertiesNode::name

Returns the identifying name of the VolumePkg.

Returns
Name of the VolumePkg

Definition at line 73 of file core.hpp.

◆ version

smgl::OutputPort<int> volcart::VolumePkgPropertiesNode::version

Returns the VolumePkg version.

Use in conjunction with volcart::VERSION_LIBRARY to verify the presence of specific VolumePkg metadata keys.

Returns
Version number of VolumePkg

Definition at line 75 of file core.hpp.

◆ volpkg

smgl::InputPort<VolumePkg::Pointer> volcart::VolumePkgPropertiesNode::volpkg

Input VolumePkg.

Definition at line 71 of file core.hpp.

◆ vpkg_

VolumePkg::Pointer volcart::VolumePkgPropertiesNode::vpkg_ {nullptr}
private

VolPkg

Definition at line 67 of file core.hpp.


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