Class Field

openpgl/include/openpgl/cpp/Field.h:32–135

* @brief Key component of the guiding libary which holds the spatio-directional guiding information * (e.g., approximation of the incoming radiance field) for a scene. * * This class is responsible for storing, learning and accessing the guiding information for a scene. * This information can be the incidence radiance field across the whole scene learned from several training * iterations dur

 * for the local incident radiance distribution.
 */
struct Field
{
    /**
     * @brief Creates a new guiding field.
     *
     * @param device The Device defining the compute architecture and optimization of the Field implementation.
     * @param args The configuration of the Field (e.g., spatial or directional representation).
     */
    Field(Device *device, const FieldConfig &args);

    /**
     * @brief Creates/Loads a guiding field from a file.
     *
     * @param device The Device defining the compute architecture and optimization of the Field implementation.
     * @param fieldFileName The location of the file the Field is loaded from.
     */
    Field(Device *device, const std::string &fieldFileName);

    ~Field();

    Field(const Field &) = delete;

    /**
     * @brief Stores Field as serialized representation to file on disk
     *
     * @param fieldFileName path where to store serialized representation
     * @return if field could be stored to file
     */
    bool Store(const std::string &fieldFileName) const;

    /**
     * @brief Sets the bounding box of the scenes.
     *
     * Sets the bounding box of the scene. This bounding box is used as
     * bounds for the spatial subdivision structures for the surface and
     * volume guiding fields. If no scene bounding box is set before
     * @ref Update is called the first time the scene bounds are estimated
     * using the first sample batch.
     * @param bounds
     */
    void SetSceneBounds(const pgl_box3f &bounds);

    /**
     * @brief Get the bounding box of the scene/
     *
     * The returned bounding box merges the bounds for the surface field and
     * the volume field.
     *
     * @return pgl_box3f
     */
    pgl_box3f GetSceneBounds() const;

    /**
     * @brief Updates the current approximation of the surface and radiance fields.
     *
     * @param sampleStorage
     */
    void Update(const SampleStorage &sampleStorage);