API reference
Here you can find the automatically generated API reference for the GISNav ROS 2 package. Use the search bar or the below module index to find what you are looking for.
Unstable API
GISNav is under active development and the public API is unstable. Use a specific commit or version tag to mitigate the impact of breaking changes.
Private API
The private API is also documented here for developer reference as the private method docstrings may contain useful information. The private API should not be relied on for any integrations.
Core nodes
- BBoxNode
- GISNode
GISNodeGISNode.ROS_D_DEM_LAYERSGISNode.ROS_D_DEM_STYLESGISNode.ROS_D_IMAGE_FORMATGISNode.ROS_D_IMAGE_TRANSPARENCYGISNode.ROS_D_LAYERSGISNode.ROS_D_MAP_OVERLAP_UPDATE_THRESHOLDGISNode.ROS_D_PUBLISH_RATEGISNode.ROS_D_SRSGISNode.ROS_D_STYLESGISNode.ROS_D_TIMEOUTGISNode.ROS_D_URLGISNode.ROS_D_VERSIONGISNode.ROS_D_WMS_POLL_RATEGISNode.bounding_boxGISNode.camera_infoGISNode.min_map_overlap_update_thresholdGISNode.old_bounding_boxGISNode.orthoimageGISNode.publish_rateGISNode.wms_dem_layersGISNode.wms_dem_stylesGISNode.wms_formatGISNode.wms_layersGISNode.wms_poll_rateGISNode.wms_srsGISNode.wms_stylesGISNode.wms_timeoutGISNode.wms_transparencyGISNode.wms_urlGISNode.wms_version
- StereoNode
- PoseNode
- TwistNode
Extension nodes
Static API
- Constants
BBOX_NODE_NAMEDELAY_DEFAULT_MSFrameIDGIS_NODE_NAMENMEA_NODE_NAMEPOSE_NODE_NAMEROS_NAMESPACEROS_TOPIC_CAMERA_INFOROS_TOPIC_IMAGEROS_TOPIC_MAVROS_GIMBAL_DEVICE_ATTITUDE_STATUSROS_TOPIC_MAVROS_GLOBAL_POSITIONROS_TOPIC_MAVROS_LOCAL_POSITIONROS_TOPIC_RELATIVE_FOV_BOUNDING_BOXROS_TOPIC_RELATIVE_MATCHES_IMAGEROS_TOPIC_RELATIVE_NAV_PVTROS_TOPIC_RELATIVE_NMEA_SENTENCEROS_TOPIC_RELATIVE_ORTHOIMAGEROS_TOPIC_RELATIVE_POSEROS_TOPIC_RELATIVE_POSE_IMAGEROS_TOPIC_RELATIVE_POSITION_IMAGEROS_TOPIC_RELATIVE_QUERY_KEYPOINTSROS_TOPIC_ROBOT_LOCALIZATION_ODOMETRYROS_TOPIC_SENSOR_GPSSTEREO_NODE_NAMETWIST_NODE_NAMEUBX_NODE_NAMEUORB_NODE_NAMEWFST_NODE_NAME
- Entry points
Tests
- Unit tests
- Launch tests
TestTopographyCaseTestTopographyCase.EXPECTED_NAMESPACESTestTopographyCase.EXPECTED_NODESTestTopographyCase.EXPECTED_TOPICSTestTopographyCase.EXPECTED_TYPESTestTopographyCase.setUp()TestTopographyCase.setUpClass()TestTopographyCase.tearDown()TestTopographyCase.tearDownClass()TestTopographyCase.test_node_names_and_namespaces()TestTopographyCase.test_topic_names_and_types()
Private API
- Decorators
- Transformations
BBoxadd_transform_stamped()affine_to_proj()angle_off_nadir()as_np_quaternion()as_ros_quaternion()bounding_box_to_bbox()create_identity_pose_stamped()create_pose_msg()create_transform_msg()ecef_to_wgs84()enu_to_ecef_matrix()extract_roll()extract_yaw()get_transform()lookup_transform()matrices_to_homogenous()pose_to_transform()poses_to_twist()proj_to_affine()transform_to_pose()usec_from_header()wgs84_to_ecef()
GISNav v0.68.1-2-gf2c72641