Package frc.robot

Record Class Constants.Vision.CameraConstants

java.lang.Object
java.lang.Record
frc.robot.Constants.Vision.CameraConstants
Enclosing class:
Constants.Vision
public static record Constants.Vision.CameraConstants(String name, int height, int width, Rotation2d horizontalFieldOfView, Frequency framesPerSecond, Time latencyAvg, Time latencyStdDev, double calibErrorAvg, double calibErrorStdDev, Transform3d robotToCamera, double offset) extends Record
Constants for an individual camera.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CameraConstants(String name, int height, int width, Rotation2d horizontalFieldOfView, Frequency framesPerSecond, Time latencyAvg, Time latencyStdDev, double calibErrorAvg, double calibErrorStdDev, Transform3d robotToCamera, double offset)
    Creates an instance of a CameraConstants record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    calibErrorAvg()
    Returns the value of the calibErrorAvg record component.
    double
    calibErrorStdDev()
    Returns the value of the calibErrorStdDev record component.
    double
    centerPixelYawRads()
     
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    Frequency
    framesPerSecond()
    Returns the value of the framesPerSecond record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    height()
    Returns the value of the height record component.
    Rotation2d
    horizontalFieldOfView()
    Returns the value of the horizontalFieldOfView record component.
    Time
    latencyAvg()
    Returns the value of the latencyAvg record component.
    Time
    latencyStdDev()
    Returns the value of the latencyStdDev record component.
    String
    name()
    Returns the value of the name record component.
    double
    offset()
    Returns the value of the offset record component.
    Transform3d
    robotToCamera()
    Returns the value of the robotToCamera record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    width()
    Returns the value of the width record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CameraConstants

      public CameraConstants(String name, int height, int width, Rotation2d horizontalFieldOfView, Frequency framesPerSecond, Time latencyAvg, Time latencyStdDev, double calibErrorAvg, double calibErrorStdDev, Transform3d robotToCamera, double offset)
      Creates an instance of a CameraConstants record class.
      Parameters:
      name - the value for the name record component
      height - the value for the height record component
      width - the value for the width record component
      horizontalFieldOfView - the value for the horizontalFieldOfView record component
      framesPerSecond - the value for the framesPerSecond record component
      latencyAvg - the value for the latencyAvg record component
      latencyStdDev - the value for the latencyStdDev record component
      calibErrorAvg - the value for the calibErrorAvg record component
      calibErrorStdDev - the value for the calibErrorStdDev record component
      robotToCamera - the value for the robotToCamera record component
      offset - the value for the offset record component

  • Method Details

    • centerPixelYawRads

      public double centerPixelYawRads()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • height

      public int height()
      Returns the value of the height record component.
      Returns:
      the value of the height record component

    • width

      public int width()
      Returns the value of the width record component.
      Returns:
      the value of the width record component

    • horizontalFieldOfView

      public Rotation2d horizontalFieldOfView()
      Returns the value of the horizontalFieldOfView record component.
      Returns:
      the value of the horizontalFieldOfView record component

    • framesPerSecond

      public Frequency framesPerSecond()
      Returns the value of the framesPerSecond record component.
      Returns:
      the value of the framesPerSecond record component

    • latencyAvg

      public Time latencyAvg()
      Returns the value of the latencyAvg record component.
      Returns:
      the value of the latencyAvg record component

    • latencyStdDev

      public Time latencyStdDev()
      Returns the value of the latencyStdDev record component.
      Returns:
      the value of the latencyStdDev record component

    • calibErrorAvg

      public double calibErrorAvg()
      Returns the value of the calibErrorAvg record component.
      Returns:
      the value of the calibErrorAvg record component

    • calibErrorStdDev

      public double calibErrorStdDev()
      Returns the value of the calibErrorStdDev record component.
      Returns:
      the value of the calibErrorStdDev record component

    • robotToCamera

      public Transform3d robotToCamera()
      Returns the value of the robotToCamera record component.
      Returns:
      the value of the robotToCamera record component

    • offset

      public double offset()
      Returns the value of the offset record component.
      Returns:
      the value of the offset record component