mirror of
https://github.com/PhotonVision/photonvision
synced 2026-06-19 00:41:41 +00:00
b729d9e917
* [photon-lib java] Fix classes with protobuf support not "announcing it" Since they didn't implement `ProtobufSerializable` this meant that most other software didn't even know protobufs were even implemented. In AdvantageKit for example this would cause it to not work it all and crash. * Run `spotlessJavaApply`
285 lines
10 KiB
Java
285 lines
10 KiB
Java
/*
|
||
* Copyright (C) Photon Vision.
|
||
*
|
||
* This program is free software: you can redistribute it and/or modify
|
||
* it under the terms of the GNU General Public License as published by
|
||
* the Free Software Foundation, either version 3 of the License, or
|
||
* (at your option) any later version.
|
||
*
|
||
* This program is distributed in the hope that it will be useful,
|
||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
* GNU General Public License for more details.
|
||
*
|
||
* You should have received a copy of the GNU General Public License
|
||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||
*/
|
||
|
||
package org.photonvision.targeting;
|
||
|
||
import edu.wpi.first.math.geometry.Transform3d;
|
||
import edu.wpi.first.util.protobuf.ProtobufSerializable;
|
||
import java.util.ArrayList;
|
||
import java.util.List;
|
||
import org.photonvision.common.dataflow.structures.Packet;
|
||
import org.photonvision.common.dataflow.structures.PacketSerde;
|
||
import org.photonvision.targeting.proto.PhotonTrackedTargetProto;
|
||
import org.photonvision.utils.PacketUtils;
|
||
|
||
public class PhotonTrackedTarget implements ProtobufSerializable {
|
||
private static final int MAX_CORNERS = 8;
|
||
|
||
private final double yaw;
|
||
private final double pitch;
|
||
private final double area;
|
||
private final double skew;
|
||
private final int fiducialId;
|
||
private final Transform3d bestCameraToTarget;
|
||
private final Transform3d altCameraToTarget;
|
||
private final double poseAmbiguity;
|
||
|
||
// Corners from the min-area rectangle bounding the target
|
||
private final List<TargetCorner> minAreaRectCorners;
|
||
|
||
// Corners from whatever corner detection method was used
|
||
private final List<TargetCorner> detectedCorners;
|
||
|
||
/** Construct a tracked target, given exactly 4 corners */
|
||
public PhotonTrackedTarget(
|
||
double yaw,
|
||
double pitch,
|
||
double area,
|
||
double skew,
|
||
int id,
|
||
Transform3d pose,
|
||
Transform3d altPose,
|
||
double ambiguity,
|
||
List<TargetCorner> minAreaRectCorners,
|
||
List<TargetCorner> detectedCorners) {
|
||
assert minAreaRectCorners.size() == 4;
|
||
|
||
if (detectedCorners.size() > MAX_CORNERS) {
|
||
detectedCorners = detectedCorners.subList(0, MAX_CORNERS);
|
||
}
|
||
|
||
this.yaw = yaw;
|
||
this.pitch = pitch;
|
||
this.area = area;
|
||
this.skew = skew;
|
||
this.fiducialId = id;
|
||
this.bestCameraToTarget = pose;
|
||
this.altCameraToTarget = altPose;
|
||
this.minAreaRectCorners = minAreaRectCorners;
|
||
this.detectedCorners = detectedCorners;
|
||
this.poseAmbiguity = ambiguity;
|
||
}
|
||
|
||
public double getYaw() {
|
||
return yaw;
|
||
}
|
||
|
||
public double getPitch() {
|
||
return pitch;
|
||
}
|
||
|
||
public double getArea() {
|
||
return area;
|
||
}
|
||
|
||
public double getSkew() {
|
||
return skew;
|
||
}
|
||
|
||
/** Get the Fiducial ID, or -1 if not set. */
|
||
public int getFiducialId() {
|
||
return fiducialId;
|
||
}
|
||
|
||
/**
|
||
* Get the ratio of best:alternate pose reprojection errors, called ambiguity. This is betweeen 0
|
||
* and 1 (0 being no ambiguity, and 1 meaning both have the same reprojection error). Numbers
|
||
* above 0.2 are likely to be ambiguous. -1 if invalid.
|
||
*/
|
||
public double getPoseAmbiguity() {
|
||
return poseAmbiguity;
|
||
}
|
||
|
||
/**
|
||
* Return a list of the 4 corners in image space (origin top left, x right, y down), in no
|
||
* particular order, of the minimum area bounding rectangle of this target
|
||
*/
|
||
public List<TargetCorner> getMinAreaRectCorners() {
|
||
return minAreaRectCorners;
|
||
}
|
||
|
||
/**
|
||
* Return a list of the n corners in image space (origin top left, x right, y down), in no
|
||
* particular order, detected for this target.
|
||
*
|
||
* <p>For fiducials, the order is known and is always counter-clock wise around the tag, like so:
|
||
*
|
||
* <pre>
|
||
* ⟶ +X 3 ----- 2
|
||
* | | |
|
||
* V | |
|
||
* +Y 0 ----- 1
|
||
* </pre>
|
||
*/
|
||
public List<TargetCorner> getDetectedCorners() {
|
||
return detectedCorners;
|
||
}
|
||
|
||
/**
|
||
* Get the transform that maps camera space (X = forward, Y = left, Z = up) to object/fiducial tag
|
||
* space (X forward, Y left, Z up) with the lowest reprojection error
|
||
*/
|
||
public Transform3d getBestCameraToTarget() {
|
||
return bestCameraToTarget;
|
||
}
|
||
|
||
/**
|
||
* Get the transform that maps camera space (X = forward, Y = left, Z = up) to object/fiducial tag
|
||
* space (X forward, Y left, Z up) with the highest reprojection error
|
||
*/
|
||
public Transform3d getAlternateCameraToTarget() {
|
||
return altCameraToTarget;
|
||
}
|
||
|
||
@Override
|
||
public int hashCode() {
|
||
final int prime = 31;
|
||
int result = 1;
|
||
long temp;
|
||
temp = Double.doubleToLongBits(yaw);
|
||
result = prime * result + (int) (temp ^ (temp >>> 32));
|
||
temp = Double.doubleToLongBits(pitch);
|
||
result = prime * result + (int) (temp ^ (temp >>> 32));
|
||
temp = Double.doubleToLongBits(area);
|
||
result = prime * result + (int) (temp ^ (temp >>> 32));
|
||
temp = Double.doubleToLongBits(skew);
|
||
result = prime * result + (int) (temp ^ (temp >>> 32));
|
||
result = prime * result + fiducialId;
|
||
result = prime * result + ((bestCameraToTarget == null) ? 0 : bestCameraToTarget.hashCode());
|
||
result = prime * result + ((altCameraToTarget == null) ? 0 : altCameraToTarget.hashCode());
|
||
temp = Double.doubleToLongBits(poseAmbiguity);
|
||
result = prime * result + (int) (temp ^ (temp >>> 32));
|
||
result = prime * result + ((minAreaRectCorners == null) ? 0 : minAreaRectCorners.hashCode());
|
||
result = prime * result + ((detectedCorners == null) ? 0 : detectedCorners.hashCode());
|
||
return result;
|
||
}
|
||
|
||
@Override
|
||
public boolean equals(Object obj) {
|
||
if (this == obj) return true;
|
||
if (obj == null) return false;
|
||
if (getClass() != obj.getClass()) return false;
|
||
PhotonTrackedTarget other = (PhotonTrackedTarget) obj;
|
||
if (Double.doubleToLongBits(yaw) != Double.doubleToLongBits(other.yaw)) return false;
|
||
if (Double.doubleToLongBits(pitch) != Double.doubleToLongBits(other.pitch)) return false;
|
||
if (Double.doubleToLongBits(area) != Double.doubleToLongBits(other.area)) return false;
|
||
if (Double.doubleToLongBits(skew) != Double.doubleToLongBits(other.skew)) return false;
|
||
if (fiducialId != other.fiducialId) return false;
|
||
if (bestCameraToTarget == null) {
|
||
if (other.bestCameraToTarget != null) return false;
|
||
} else if (!bestCameraToTarget.equals(other.bestCameraToTarget)) return false;
|
||
if (altCameraToTarget == null) {
|
||
if (other.altCameraToTarget != null) return false;
|
||
} else if (!altCameraToTarget.equals(other.altCameraToTarget)) return false;
|
||
if (Double.doubleToLongBits(poseAmbiguity) != Double.doubleToLongBits(other.poseAmbiguity))
|
||
return false;
|
||
if (minAreaRectCorners == null) {
|
||
if (other.minAreaRectCorners != null) return false;
|
||
} else if (!minAreaRectCorners.equals(other.minAreaRectCorners)) return false;
|
||
if (detectedCorners == null) {
|
||
if (other.detectedCorners != null) return false;
|
||
} else if (!detectedCorners.equals(other.detectedCorners)) return false;
|
||
return true;
|
||
}
|
||
|
||
@Override
|
||
public String toString() {
|
||
return "PhotonTrackedTarget{"
|
||
+ "yaw="
|
||
+ yaw
|
||
+ ", pitch="
|
||
+ pitch
|
||
+ ", area="
|
||
+ area
|
||
+ ", skew="
|
||
+ skew
|
||
+ ", fiducialId="
|
||
+ fiducialId
|
||
+ ", cameraToTarget="
|
||
+ bestCameraToTarget
|
||
+ ", targetCorners="
|
||
+ minAreaRectCorners
|
||
+ '}';
|
||
}
|
||
|
||
public static final class APacketSerde implements PacketSerde<PhotonTrackedTarget> {
|
||
@Override
|
||
public int getMaxByteSize() {
|
||
return Double.BYTES * (5 + 7 + 2 * 4 + 1 + 7 + 2 * MAX_CORNERS);
|
||
}
|
||
|
||
@Override
|
||
public void pack(Packet packet, PhotonTrackedTarget value) {
|
||
packet.encode(value.yaw);
|
||
packet.encode(value.pitch);
|
||
packet.encode(value.area);
|
||
packet.encode(value.skew);
|
||
packet.encode(value.fiducialId);
|
||
PacketUtils.packTransform3d(packet, value.bestCameraToTarget);
|
||
PacketUtils.packTransform3d(packet, value.altCameraToTarget);
|
||
packet.encode(value.poseAmbiguity);
|
||
|
||
for (int i = 0; i < 4; i++) {
|
||
TargetCorner.serde.pack(packet, value.minAreaRectCorners.get(i));
|
||
}
|
||
|
||
packet.encode((byte) Math.min(value.detectedCorners.size(), Byte.MAX_VALUE));
|
||
for (TargetCorner targetCorner : value.detectedCorners) {
|
||
TargetCorner.serde.pack(packet, targetCorner);
|
||
}
|
||
}
|
||
|
||
@Override
|
||
public PhotonTrackedTarget unpack(Packet packet) {
|
||
var yaw = packet.decodeDouble();
|
||
var pitch = packet.decodeDouble();
|
||
var area = packet.decodeDouble();
|
||
var skew = packet.decodeDouble();
|
||
var fiducialId = packet.decodeInt();
|
||
Transform3d best = PacketUtils.unpackTransform3d(packet);
|
||
Transform3d alt = PacketUtils.unpackTransform3d(packet);
|
||
double ambiguity = packet.decodeDouble();
|
||
|
||
var minAreaRectCorners = new ArrayList<TargetCorner>(4);
|
||
for (int i = 0; i < 4; i++) {
|
||
minAreaRectCorners.add(TargetCorner.serde.unpack(packet));
|
||
}
|
||
|
||
var len = packet.decodeByte();
|
||
var detectedCorners = new ArrayList<TargetCorner>(len);
|
||
for (int i = 0; i < len; i++) {
|
||
detectedCorners.add(TargetCorner.serde.unpack(packet));
|
||
}
|
||
|
||
return new PhotonTrackedTarget(
|
||
yaw,
|
||
pitch,
|
||
area,
|
||
skew,
|
||
fiducialId,
|
||
best,
|
||
alt,
|
||
ambiguity,
|
||
minAreaRectCorners,
|
||
detectedCorners);
|
||
}
|
||
}
|
||
|
||
public static final APacketSerde serde = new APacketSerde();
|
||
public static final PhotonTrackedTargetProto proto = new PhotonTrackedTargetProto();
|
||
}
|