docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class RecognizedObjectMsg

    ROS object_recognition_msgs/RecognizedObject message.

    Inheritance
    object
    RecognizedObjectMsg
    Implements
    IMessage
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Unity.SimulationPro.Foundation.ObjectRecognitionMessages
    Assembly: Unity.SimulationPro.Foundation.dll
    Syntax
    [Serializable]
    public class RecognizedObjectMsg : IMessage

    Constructors

    RecognizedObjectMsg()

    Initializes a new instance with default values.

    Declaration
    public RecognizedObjectMsg()

    RecognizedObjectMsg(HeaderMsg, ObjectTypeMsg, float, PointCloud2Msg[], MeshMsg, PointMsg[], PoseWithCovarianceStampedMsg)

    Initializes a new instance with default values.

    Declaration
    public RecognizedObjectMsg(HeaderMsg header, ObjectTypeMsg type, float confidence, PointCloud2Msg[] point_clouds, MeshMsg bounding_mesh, PointMsg[] bounding_contours, PoseWithCovarianceStampedMsg pose)
    Parameters
    Type Name Description
    HeaderMsg header

    ROS message header containing timestamp and coordinate frame identifier.

    ObjectTypeMsg type

    Integer type code specifying the variant or category.

    float confidence

    Recognition confidence score.

    PointCloud2Msg[] point_clouds

    Array of point cloud data.

    MeshMsg bounding_mesh

    Mesh defining the object's bounding volume.

    PointMsg[] bounding_contours

    Array of contour points defining the bounding region.

    PoseWithCovarianceStampedMsg pose

    Position and orientation in 3D space.

    Fields

    bounding_contours

    Sometimes, you only have 2d input so you can't really give a pose, you just get a contour, or a box The last point will be linked to the first one automatically

    Declaration
    public PointMsg[] bounding_contours
    Field Value
    Type Description
    PointMsg[]

    bounding_mesh

    Sometimes, you can only provide a bounding box/shape, even in 3d This is in the pose frame

    Declaration
    public MeshMsg bounding_mesh
    Field Value
    Type Description
    MeshMsg

    confidence

    confidence: how sure you are it is that object and not another one. It is between 0 and 1 and the closer to one it is the better

    Declaration
    public float confidence
    Field Value
    Type Description
    float

    header

    #################################################### HEADER ########################################################### The header frame corresponds to the pose frame, NOT the point_cloud frame.

    Declaration
    public HeaderMsg header
    Field Value
    Type Description
    HeaderMsg

    k_MessageTypeId

    Identifier for this message type.

    Declaration
    public static readonly MessageTypeId k_MessageTypeId
    Field Value
    Type Description
    MessageTypeId

    k_MessageTypeName

    The ROS message type name string used for serialization and topic matching.

    Declaration
    public const string k_MessageTypeName = "object_recognition_msgs/RecognizedObject"
    Field Value
    Type Description
    string

    point_clouds

    ############################################### OBJECT CLUSTERS ####################################################### Sometimes you can extract the 3d points that belong to the object, in the frames of the original sensors (it is an array as you might have several sensors)

    Declaration
    public PointCloud2Msg[] point_clouds
    Field Value
    Type Description
    PointCloud2Msg[]

    pose

    ################################################### POSE INFO ######################################################### This is the result that everybody expects : the pose in some frame given with the input. The units are radian/meters as usual

    Declaration
    public PoseWithCovarianceStampedMsg pose
    Field Value
    Type Description
    PoseWithCovarianceStampedMsg

    type

    ################################################# OBJECT INFO ######################################################### Contains information about the type and the position of a found object Some of those fields might not be filled because the used techniques do not fill them or because the user does not request them The type of the found object

    Declaration
    public ObjectTypeMsg type
    Field Value
    Type Description
    ObjectTypeMsg

    Properties

    MessageTypeId

    Gets the unique runtime identifier for this message type.

    Declaration
    public MessageTypeId MessageTypeId { get; }
    Property Value
    Type Description
    MessageTypeId

    MessageTypeName

    Gets the ROS message type name for this message.

    Declaration
    public string MessageTypeName { get; }
    Property Value
    Type Description
    string

    Methods

    Deserialize(IMessageDeserializer)

    Deserializes a RecognizedObjectMsg from the given deserializer.

    Declaration
    public static RecognizedObjectMsg Deserialize(IMessageDeserializer deserializer)
    Parameters
    Type Name Description
    IMessageDeserializer deserializer

    The deserializer.

    Returns
    Type Description
    RecognizedObjectMsg

    A new RecognizedObjectMsg instance.

    Register()

    Registers this message type with the MessageTypeRegistry.

    Declaration
    [InitializeOnLoadMethod]
    public static void Register()

    ToString()

    Returns a human-readable string representation of this message.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    A string representation of this instance.

    Overrides
    object.ToString()

    WriteTo(IMessageSerializer)

    Serializes this message to the given serializer.

    Declaration
    public void WriteTo(IMessageSerializer serializer)
    Parameters
    Type Name Description
    IMessageSerializer serializer

    The serializer.

    Implements

    IMessage
    In This Article
    Back to top
    Copyright © 2026 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)