docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class ObservationWriter

    Allows sensors to write to both TensorProxy and float arrays/lists.

    Inheritance
    object
    ObservationWriter
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Unity.MLAgents.Sensors
    Assembly: Unity.ML-Agents.dll
    Syntax
    public class ObservationWriter

    Properties

    this[int]

    1D write access at a specified index. Use AddList if possible instead.

    Declaration
    public float this[int index] { set; }
    Parameters
    Type Name Description
    int index

    Index to write to.

    Property Value
    Type Description
    float

    this[int, int, int]

    3D write access at the specified height, width, and channel.

    Declaration
    public float this[int h, int w, int ch] { set; }
    Parameters
    Type Name Description
    int h
    int w
    int ch
    Property Value
    Type Description
    float

    Methods

    Add(Quaternion, int)

    Write the Quaternion components.

    Declaration
    public void Add(Quaternion quat, int writeOffset = 0)
    Parameters
    Type Name Description
    Quaternion quat

    The Quaternion to be written.

    int writeOffset

    Optional write offset.

    Add(Vector3, int)

    Write the Vector3 components.

    Declaration
    public void Add(Vector3 vec, int writeOffset = 0)
    Parameters
    Type Name Description
    Vector3 vec

    The Vector3 to be written.

    int writeOffset

    Optional write offset.

    Add(Vector4, int)

    Write the Vector4 components.

    Declaration
    public void Add(Vector4 vec, int writeOffset = 0)
    Parameters
    Type Name Description
    Vector4 vec

    The Vector4 to be written.

    int writeOffset

    Optional write offset.

    AddList(IList<float>, int)

    Write the list of floats.

    Declaration
    public void AddList(IList<float> data, int writeOffset = 0)
    Parameters
    Type Name Description
    IList<float> data

    The actual list of floats to write.

    int writeOffset

    Optional write offset to start writing from.

    Extension Methods

    ObservationWriterExtension.WriteTexture(ObservationWriter, Texture2D, bool)

    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Properties
      • this[int]
      • this[int, int, int]
    • Methods
      • Add(Quaternion, int)
      • Add(Vector3, int)
      • Add(Vector4, int)
      • AddList(IList<float>, int)
    • Extension Methods
    Back to top
    Copyright © 2025 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)