Index (Synapse)

A B C D E G H I K M N R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

acceptedError - Variable in class synapse.pipelines.apriltag.ApriltagPoseEstimate: The error metric (e.g., reprojection error) associated with ApriltagPoseEstimate.acceptedPose.
acceptedPose - Variable in class synapse.pipelines.apriltag.ApriltagPoseEstimate: The first possible 3D pose of the AprilTag relative to the camera or robot frame, represented as [x, y, z, roll, pitch, yaw].
ApriltagDetection - Class in synapse.pipelines.apriltag: Represents a single detected AprilTag along with its associated metadata and pose estimates.
ApriltagDetection() - Constructor for class synapse.pipelines.apriltag.ApriltagDetection: Creates a new, empty ApriltagDetection.
ApriltagPoseEstimate - Class in synapse.pipelines.apriltag: Represents the candidate 3D pose estimates of an AprilTag detection.
ApriltagPoseEstimate() - Constructor for class synapse.pipelines.apriltag.ApriltagPoseEstimate: Creates a new ApriltagPoseEstimate with errors initialized to 0.0 and poses set to null.
ApriltagResult - Class in synapse.pipelines.apriltag: Represents the result of detecting AprilTags in a single frame or input source.
ApriltagResult() - Constructor for class synapse.pipelines.apriltag.ApriltagResult: Creates a new, empty ApriltagResult.
area - Variable in class synapse.pipelines.color.ColorDetection: Area of the detected color region in pixels squared.

B

bbox - Variable in class synapse.pipelines.color.ColorDetection: Bounding box of the detected color region as [x, y, width, height].

C

cameraEstimate_fieldSpace - Variable in class synapse.pipelines.apriltag.ApriltagResult: The estimated camera pose in field space represented as an array of doubles.
cameraPose_fieldSpace - Variable in class synapse.pipelines.apriltag.ApriltagDetection: The estimated pose of the camera in the field coordinate system.
cameraPose_tagSpace - Variable in class synapse.pipelines.apriltag.ApriltagDetection: The estimated pose of the camera relative to the detected tag.
center - Variable in class synapse.pipelines.color.ColorDetection: Center of the detected color region as [x, y].
ColorDetection - Class in synapse.pipelines.color: Represents the result of a color detection pipeline.
ColorDetection() - Constructor for class synapse.pipelines.color.ColorDetection: Default constructor.
ColorResult - Class in synapse.pipelines.color: Represents the result of a color detection pipeline run.
ColorResult() - Constructor for class synapse.pipelines.color.ColorResult

D

deserialize(JsonParser, DeserializationContext) - Method in class synapse.util.deserializers.GeometryDeserializer: Deserializes a JSON object into the target WPILib geometry type.
detections - Variable in class synapse.pipelines.color.ColorResult: All color detections found in the frame.
doubleArraySetting(String) - Static method in class synapse.SynapseCamera.Setting: Creates a Setting representing a double array value.
doubleSetting(String) - Static method in class synapse.SynapseCamera.Setting: Creates a Setting representing a Double value.

E

equals(Object) - Method in class synapse.pipelines.apriltag.ApriltagDetection: Compares this ApriltagDetection with another object for equality.
equals(Object) - Method in class synapse.pipelines.apriltag.ApriltagPoseEstimate: Checks whether this ApriltagPoseEstimate is equal to another object.
equals(Object) - Method in class synapse.pipelines.apriltag.ApriltagResult: Compares this result to another object for equality.
equals(Object) - Method in class synapse.pipelines.color.ColorDetection: Compares this ColorResult to another object for equality.
equals(Object) - Method in class synapse.pipelines.color.ColorResult: Compares this ColorResult to another object for equality.
estimateRobotPose(Pose3d) - Method in class synapse.SynapseCamera: Converts a given camera pose into a robot pose using the configured robot-to-camera offset.

G

generic(String, Class<T>, NetworkTableType) - Static method in class synapse.SynapseCamera.Setting: Creates a generic Setting with a custom type and NetworkTableType.
GeometryDeserializer<T> - Class in synapse.util.deserializers: Generic deserializer for WPILib geometry classes such as Translation2d, Rotation2d, Pose2d, Transform2d, and their 3D counterparts.
GeometryDeserializer(Class<T>) - Constructor for class synapse.util.deserializers.GeometryDeserializer: Constructs a GeometryDeserializer for a specific WPILib geometry type.
getCachedEntry(String, NetworkTable) - Method in class synapse.SynapseCamera: Retrieves a cached NetworkTableEntry for a given key.
getCameraName() - Method in class synapse.SynapseCamera: Returns the camera name.
getCaptureLatency() - Method in class synapse.SynapseCamera: Returns the latest capture latency in milliseconds.
getDataTable() - Method in class synapse.SynapseCamera: Returns the data/results subtable.
getKey() - Method in class synapse.SynapseCamera.Setting
getNtType() - Method in class synapse.SynapseCamera.Setting
getPipeline() - Method in class synapse.SynapseCamera: Returns the current pipeline ID or -1 if unset.
getPipelineType() - Method in class synapse.SynapseCamera: Returns the pipeline type string.
getProcessLatency() - Method in class synapse.SynapseCamera: Returns the latest processing latency in milliseconds.
getRecordingStatus() - Method in class synapse.SynapseCamera: Returns whether the camera is currently recording.
getResults(TypeReference<T>, byte[]) - Method in class synapse.SynapseCamera: Deserialize results from serialized MessagePack data.
getResults(SynapsePipelineType<T>) - Method in class synapse.SynapseCamera: Retrieve and deserialize results from the given pipeline.
getResultsEntry() - Method in class synapse.SynapseCamera: Returns the results entry.
getRobotToCameraOffset() - Method in class synapse.SynapseCamera: Returns the transform offset from the robot frame to the camera frame.
getSetting(String) - Method in class synapse.SynapseCamera: Deprecated, for removal: This API element is subject to removal in a future version.
getSetting(SynapseCamera.Setting<T>) - Method in class synapse.SynapseCamera: Typed getter for camera settings.
getSettingsTable() - Method in class synapse.SynapseCamera: Returns the settings subtable.
getTypeReference() - Method in class synapse.SynapsePipelineType: Gets the TypeReference for this pipeline.
getValueType() - Method in class synapse.SynapseCamera.Setting

H

hamming - Variable in class synapse.pipelines.apriltag.ApriltagDetection: The Hamming distance of the detected tag, representing the number of bit errors.
hashCode() - Method in class synapse.pipelines.apriltag.ApriltagDetection: Computes a hash code for this ApriltagDetection.
hashCode() - Method in class synapse.pipelines.apriltag.ApriltagPoseEstimate: Computes a hash code for this ApriltagPoseEstimate.
hashCode() - Method in class synapse.pipelines.apriltag.ApriltagResult: Computes a hash code for this result based on its detected tags and camera field space estimate.
hashCode() - Method in class synapse.pipelines.color.ColorDetection: Computes a hash code for this ColorResult.
hashCode() - Method in class synapse.pipelines.color.ColorResult: Computes a hash code for this ColorResult.

I

integerSetting(String) - Static method in class synapse.SynapseCamera.Setting: Creates a Setting representing an Integer (Long) value.
isJUnitTest() - Static method in class synapse.SynapseCamera: Checks whether the current execution is in a JUnit or TestNG test.

K

kApriltag - Static variable in class synapse.SynapsePipelineType: The AprilTag pipeline.
kBrightness - Static variable in class synapse.SynapseCamera.Setting: Predefined setting for camera brightness
kCaptureLatencyTopic - Static variable in class synapse.SynapseCamera.NetworkTableTopics: Topic for camera capture latency (ms)
kColor - Static variable in class synapse.SynapsePipelineType: The color detection pipeline.
kExposure - Static variable in class synapse.SynapseCamera.Setting: Predefined setting for camera exposure
key - Variable in class synapse.SynapseCamera.Setting: The key used to identify this setting in the NetworkTable.
kGain - Static variable in class synapse.SynapseCamera.Setting: Predefined setting for camera gain
kOrientation - Static variable in class synapse.SynapseCamera.Setting: Predefined setting for camera orientation
kPipelineTopic - Static variable in class synapse.SynapseCamera.NetworkTableTopics: Topic for the current pipeline ID
kPipelineTypeTopic - Static variable in class synapse.SynapseCamera.NetworkTableTopics: Topic for the pipeline type string
kProcessLatencyTopic - Static variable in class synapse.SynapseCamera.NetworkTableTopics: Topic for camera processing latency (ms)
kRecordStatusTopic - Static variable in class synapse.SynapseCamera.NetworkTableTopics: Topic for recording state
kResultsTopic - Static variable in class synapse.SynapseCamera.NetworkTableTopics: Topic for results data

M

m_cameraName - Variable in class synapse.SynapseCamera: Camera name
m_captureLatencyEntry - Variable in class synapse.SynapseCamera: Entry for tracking the latency of frame capture (in milliseconds)
m_dataTable - Variable in class synapse.SynapseCamera: Subtable containing camera data/results
m_entryCache - Variable in class synapse.SynapseCamera: Cache of all NetworkTableEntries for quick access
m_pipelineEntry - Variable in class synapse.SynapseCamera: Cached entry for the current pipeline ID
m_pipelineTypeEntry - Variable in class synapse.SynapseCamera: Entry for storing or retrieving the camera's current pipeline type
m_processLatencyEntry - Variable in class synapse.SynapseCamera: Entry for tracking the latency of frame processing (in milliseconds)
m_recordStateEntry - Variable in class synapse.SynapseCamera: Entry that indicates whether recording is currently active
m_resultsEntry - Variable in class synapse.SynapseCamera: Entry for storing the latest processing results from the camera
m_robotToCameraOffset - Variable in class synapse.SynapseCamera: Transform representing the physical offset between the robot's coordinate frame and the camera's coordinate frame.
m_settingsTable - Variable in class synapse.SynapseCamera: Subtable containing camera settings
m_table - Variable in class synapse.SynapseCamera: Root table for this camera
main_detection - Variable in class synapse.pipelines.color.ColorResult: The primary or best color detection for this frame.

N

NetworkTableTopics() - Constructor for class synapse.SynapseCamera.NetworkTableTopics: Prevent instantiation
ntType - Variable in class synapse.SynapseCamera.Setting: The NetworkTableType corresponding to this setting (e.g., kDouble, kString).

R

rejectedError - Variable in class synapse.pipelines.apriltag.ApriltagPoseEstimate: The error metric (e.g., reprojection error) associated with ApriltagPoseEstimate.rejectedPose.
rejectedPose - Variable in class synapse.pipelines.apriltag.ApriltagPoseEstimate: The second possible 3D pose of the AprilTag relative to the camera or robot frame, represented as [x, y, z, roll, pitch, yaw].

S

s_ObjectMapper - Static variable in class synapse.SynapseCamera: ObjectMapper configured for MessagePack serialization/deserialization
setPipeline(long) - Method in class synapse.SynapseCamera: Sets the current pipeline ID.
setRecordStatus(boolean) - Method in class synapse.SynapseCamera: Sets the camera recording status.
setRobotToCameraOffset(Transform3d) - Method in class synapse.SynapseCamera: Assigns the transform offset between the robot and camera coordinate frames.
setSetting(SynapseCamera.Setting<T>, T) - Method in class synapse.SynapseCamera: Typed setter for camera settings.
Setting(String, Class<T>, NetworkTableType) - Constructor for class synapse.SynapseCamera.Setting: Constructs a new Setting.
stringArraySetting(String) - Static method in class synapse.SynapseCamera.Setting: Creates a Setting representing a string array value.
stringSetting(String) - Static method in class synapse.SynapseCamera.Setting: Creates a Setting representing a String value.
synapse - package synapse
synapse.pipelines.apriltag - package synapse.pipelines.apriltag
synapse.pipelines.color - package synapse.pipelines.color
synapse.util.deserializers - package synapse.util.deserializers
SynapseCamera - Class in synapse: Represents a Synapse camera with fully cached NetworkTables entries, type-safe settings, and methods for retrieving results and metrics.
SynapseCamera(String) - Constructor for class synapse.SynapseCamera: Constructs a new SynapseCamera using the default coprocessor table name "Synapse".
SynapseCamera(String, String) - Constructor for class synapse.SynapseCamera: Constructs a new SynapseCamera with a specific coprocessor table name.
SynapseCamera.NetworkTableTopics - Class in synapse: Standardized NetworkTables topic keys for pipelines, results, recording, and latency.
SynapseCamera.Setting<T> - Class in synapse: Represents a typed Synapse setting that can be stored in a NetworkTable.
SynapsePipelineType<T> - Class in synapse: Represents a Synapse pipeline.
SynapsePipelineType(TypeReference<T>, String) - Constructor for class synapse.SynapsePipelineType: Constructor for the SynapsePipeline class.
synapseTableName - Variable in class synapse.SynapseCamera: Name of the Synapse NetworkTables table

T

tag_estimate - Variable in class synapse.pipelines.apriltag.ApriltagDetection: The estimated pose(s) of the detected AprilTag, including multiple hypotheses or refined estimates if available.
tagID - Variable in class synapse.pipelines.apriltag.ApriltagDetection: The unique ID of the detected AprilTag.
tagPose_screenSpace - Variable in class synapse.pipelines.apriltag.ApriltagDetection: The estimated pose of the tag in screen coordinates.
tags - Variable in class synapse.pipelines.apriltag.ApriltagResult: The array of detected AprilTags with their associated detection data.
timestamp - Variable in class synapse.pipelines.color.ColorResult: Timestamp (in seconds) at which this result was captured or processed.
typestring - Variable in class synapse.SynapsePipelineType: The string identifier for this pipeline, used as the topic name.

V

valueType - Variable in class synapse.SynapseCamera.Setting: The Java class of the value type for this setting.

W

withRobotToCameraOffset(Transform3d) - Method in class synapse.SynapseCamera: Sets the transform offset between the robot reference frame and the camera, and returns this instance for chaining.
WPILibGeometryModule - Class in synapse.util.deserializers: Jackson module that registers deserializers for WPILib geometry classes.
WPILibGeometryModule() - Constructor for class synapse.util.deserializers.WPILibGeometryModule: Constructs a new WPILibGeometryModule and registers deserializers for all supported WPILib geometry types.

A B C D E G H I K M N R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form