Public Types | Public Member Functions | Public Attributes | List of all members
gtsam::GraphvizFormatting Struct Reference

#include <NonlinearFactorGraph.h>

Public Types

enum  Axis {
  X, Y, Z, NEGX,
  NEGY, NEGZ
}
 

Public Member Functions

 GraphvizFormatting ()
 

Public Attributes

bool binaryEdges
 just use non-dotted edges for binary factors More...
 
bool connectKeysToFactor
 Draw a line from each key within a factor to the dot of the factor. More...
 
std::map< size_t, Point2factorPositions
 
double figureHeightInches
 The figure height on paper in inches. More...
 
double figureWidthInches
 The figure width on paper in inches. More...
 
bool mergeSimilarFactors
 Merge multiple factors that have the same connectivity. More...
 
Axis paperHorizontalAxis
 The world axis assigned to the horizontal paper axis. More...
 
Axis paperVerticalAxis
 The world axis assigned to the vertical paper axis. More...
 
bool plotFactorPoints
 Plots each factor as a dot between the variables. More...
 
double scale
 Scale all positions to reduce / increase density. More...
 

Detailed Description

Formatting options when saving in GraphViz format using NonlinearFactorGraph::saveGraph.

Definition at line 48 of file NonlinearFactorGraph.h.

Member Enumeration Documentation

Enumerator
NEGX 
NEGY 
NEGZ 

Definition at line 49 of file NonlinearFactorGraph.h.

Constructor & Destructor Documentation

gtsam::GraphvizFormatting::GraphvizFormatting ( )
inline

Default constructor sets up robot coordinates. Paper horizontal is robot Y, paper vertical is robot X. Default figure size of 5x5 in.

Definition at line 62 of file NonlinearFactorGraph.h.

Member Data Documentation

bool gtsam::GraphvizFormatting::binaryEdges

just use non-dotted edges for binary factors

Definition at line 58 of file NonlinearFactorGraph.h.

bool gtsam::GraphvizFormatting::connectKeysToFactor

Draw a line from each key within a factor to the dot of the factor.

Definition at line 57 of file NonlinearFactorGraph.h.

std::map<size_t, Point2> gtsam::GraphvizFormatting::factorPositions

(optional for each factor) Manually specify factor "dot" positions.

Definition at line 59 of file NonlinearFactorGraph.h.

double gtsam::GraphvizFormatting::figureHeightInches

The figure height on paper in inches.

Definition at line 53 of file NonlinearFactorGraph.h.

double gtsam::GraphvizFormatting::figureWidthInches

The figure width on paper in inches.

Definition at line 52 of file NonlinearFactorGraph.h.

bool gtsam::GraphvizFormatting::mergeSimilarFactors

Merge multiple factors that have the same connectivity.

Definition at line 55 of file NonlinearFactorGraph.h.

Axis gtsam::GraphvizFormatting::paperHorizontalAxis

The world axis assigned to the horizontal paper axis.

Definition at line 50 of file NonlinearFactorGraph.h.

Axis gtsam::GraphvizFormatting::paperVerticalAxis

The world axis assigned to the vertical paper axis.

Definition at line 51 of file NonlinearFactorGraph.h.

bool gtsam::GraphvizFormatting::plotFactorPoints

Plots each factor as a dot between the variables.

Definition at line 56 of file NonlinearFactorGraph.h.

double gtsam::GraphvizFormatting::scale

Scale all positions to reduce / increase density.

Definition at line 54 of file NonlinearFactorGraph.h.


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


gtsam
Author(s):
autogenerated on Sat May 8 2021 02:58:12