Package org.photonvision.targeting

Class PhotonPipelineMetadata

java.lang.Object

org.photonvision.targeting.PhotonPipelineMetadata

All Implemented Interfaces:

PhotonStructSerializable<PhotonPipelineMetadata>

public class PhotonPipelineMetadata
extends Object
implements PhotonStructSerializable<PhotonPipelineMetadata>

Field Summary

Fields

Modifier and Type	Field	Description
long	captureTimestampMicros
static final PhotonPipelineMetadataSerde	photonStruct
long	publishTimestampMicros
long	sequenceID
long	timeSinceLastPong

Constructor Summary

Constructors

Constructor	Description
PhotonPipelineMetadata()
PhotonPipelineMetadata(long captureTimestampMicros, long publishTimestampMicros, long sequenceID, long timeSinceLastPong)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
long	getCaptureTimestampMicros()	The time that this image was captured, in the coprocessor's time base.
double	getLatencyMillis()	Returns the time between image capture and publish to NT
long	getPublishTimestampMicros()	The time that this result was published to NT, in the coprocessor's time base.
long	getSequenceID()	The number of non-empty frames processed by this camera since boot.
PacketSerde<PhotonPipelineMetadata>	getSerde()	Returns the PhotonStruct serializer for this type.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

captureTimestampMicros

public long captureTimestampMicros

publishTimestampMicros

public long publishTimestampMicros

sequenceID

public long sequenceID

timeSinceLastPong

public long timeSinceLastPong

photonStruct

public static final PhotonPipelineMetadataSerde photonStruct

Constructor Details

PhotonPipelineMetadata

public PhotonPipelineMetadata(long captureTimestampMicros,
 long publishTimestampMicros,
 long sequenceID,
 long timeSinceLastPong)

PhotonPipelineMetadata

public PhotonPipelineMetadata()

Method Details

getLatencyMillis

public double getLatencyMillis()

Returns the time between image capture and publish to NT

Returns:

The time in milliseconds

getCaptureTimestampMicros

public long getCaptureTimestampMicros()

The time that this image was captured, in the coprocessor's time base.

Returns:

The time in microseconds

getPublishTimestampMicros

public long getPublishTimestampMicros()

The time that this result was published to NT, in the coprocessor's time base.

Returns:

The time in microseconds

getSequenceID

public long getSequenceID()

The number of non-empty frames processed by this camera since boot. Useful to checking if a camera is alive.

Returns:

The number of non-empty frames

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getSerde

public PacketSerde<PhotonPipelineMetadata> getSerde()

Description copied from interface: PhotonStructSerializable

Returns the PhotonStruct serializer for this type.

Specified by:

getSerde in interface PhotonStructSerializable<PhotonPipelineMetadata>

Returns:

The PhotonStruct serializer