Methods

{
  "name": "STBImage",
  "namespace": "sofa::helper::io",
  "module": "Sofa.framework.Helper",
  "include": "sofa/helper/io/STBImage.h",
  "doc": "",
  "inherits": [
    "Image"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "setSTBCreators",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": true,
      "access": "public"
    },
    {
      "name": "load",
      "return_type": "bool",
      "params": [
        {
          "name": "filename",
          "type": "int"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "save",
      "return_type": "bool",
      "params": [
        {
          "name": "filename",
          "type": "int"
        },
        {
          "name": "compression_level",
          "type": "int"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `STBImage` class in the SOFA framework is part of the `sofa::helper::io` namespace and belongs to the `Sofa.framework.Helper` module. It inherits from the `Image` class, which suggests it is used for handling image loading and saving operations within the framework.\n\n### Role and Purpose\nThe primary role of `STBImage` is to provide an interface for loading and saving images using the STB library (Simple Tiny Bitmap). This component facilitates integrating different image formats into SOFA simulations or visualizations, allowing users to easily load textures or other image data.\n\n### Interactions with Other Components\n- **Inheritance**: It inherits from `Image`, indicating that it follows the interface and conventions defined by this base class.\n- **Static Methods**: The static method `setSTBCreators()` sets up creators for various supported extensions, enabling the framework to recognize different image formats.\n- **Load Method**: The `load` method loads images into memory. It returns a boolean indicating success or failure and initializes the internal state of the image with the loaded data.\n- **Save Method**: The `save` method saves the current image in various supported formats, taking an optional compression level parameter for JPEG files.\n\n### Practical Usage Guidance\n- **Loading Images**: Use the `load` method to load images from a specified file path. If successful, the image is loaded into memory and can be used within SOFA simulations or visualizations.\n- **Saving Images**: The `save` method allows saving the current state of an image to disk in various formats such as PNG, JPEG, BMP, TGA.\n\n### Data Fields\nNo explicit data fields are defined directly within this component. However, it relies on the underlying `Image` class for its internal representation and management of pixel data.",
  "maths": "The `STBImage` class in the SOFA framework is primarily designed for handling image loading and saving operations using the STB library. This component does not directly contribute to any governing equations or operators related to Finite Element Method (FEM) simulations, such as mass matrices, stiffness matrices, internal forces, residuals, constitutive laws, constraints, or mappings. Instead, it serves a supporting role in providing image data that can be used for texture mapping, visualization, or other auxiliary purposes within the simulation environment.\n\n### Mathematical and Physical Description\n\n- **Governing Equations/Operators**: The `STBImage` component does not implement any specific governing equations or operators related to FEM. It is purely an I/O utility that loads images into memory from file paths and saves them back to disk in various formats.\n\n- **Constitutive/Kinematic Laws**: There are no constitutive laws or kinematic formulations involved with `STBImage`. Its functionality is limited to handling pixel data for image files, which does not involve any physical modeling or mechanical behavior of deformable systems.\n\n- **Role in the Global FEM Pipeline**: In the context of the broader FEM simulation pipeline, `STBImage` plays no direct role in assembly, time integration, nonlinear solve, linear solve, constraint handling, mapping, etc. It is an auxiliary component that can be used to load texture data or other image-related content for visualization purposes.\n\n- **Numerical Methods/Discretization Choices**: The numerical methods and discretization choices are not applicable here as `STBImage` does not perform any mathematical operations relevant to FEM simulations. Its main functionality involves file I/O operations using the STB library, which is a lightweight image processing library providing functions for loading and saving images in various formats.\n\n- **Variational/Lagrangian Mechanics Framework**: The component does not fit into the variational or Lagrangian mechanics framework as it pertains to purely functional aspects of loading and saving image data. It serves as a tool for preparing visual assets that might be used alongside simulations but has no direct influence on the mechanical modeling or numerical simulation process.\n\n### Summary\nThe `STBImage` component in SOFA is an I/O utility for handling images using the STB library, with no involvement in any mathematical or physical aspects of FEM simulations. It provides methods to load and save image files but does not contribute to the core mechanics or numerical resolution of deformable systems.",
  "abstract": "`STBImage` provides an interface for loading and saving images using the STB library, facilitating image handling in SOFA simulations or visualizations.",
  "sheet": "# STBImage\n\n## Overview\nThe `STBImage` component is part of the `sofa::helper::io` namespace within the `Sofa.framework.Helper` module. It inherits from the `Image` class and provides functionality for loading and saving images using the STB library, enabling integration of various image formats into SOFA simulations or visualizations.\n\n## Dependencies and Connections\n- **Inheritance**: Inherits from `Image`, adhering to its interface and conventions.\n- **Static Methods**: The static method `setSTBCreators()` sets up creators for supported extensions, allowing the framework to recognize different image formats.\n- **Load Method**: The `load` method loads images into memory, returning a boolean indicating success or failure.\n- **Save Method**: The `save` method saves the current state of an image to disk in various formats with optional compression level parameters."
}