{
  "name": "ImageRAW",
  "main": {
    "name": "ImageRAW",
    "namespace": "sofa::helper::io",
    "module": "Sofa.framework.Helper",
    "include": "sofa/helper/io/ImageRAW.h",
    "doc": "",
    "inherits": [
      "Image"
    ],
    "templates": [],
    "data_fields": [],
    "links": [],
    "methods": [
      {
        "name": "initHeader",
        "return_type": "void",
        "params": [
          {
            "name": "hsize",
            "type": "unsigned int"
          }
        ],
        "is_virtual": false,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      },
      {
        "name": "getHeaderSize",
        "return_type": "unsigned int",
        "params": [],
        "is_virtual": false,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      },
      {
        "name": "getHeader",
        "return_type": "unsigned char *",
        "params": [],
        "is_virtual": false,
        "is_pure_virtual": false,
        "is_static": false,
        "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"
      }
    ]
  },
  "desc": {
    "description": "The `ImageRAW` class in the SOFA framework (`sofa::helper::io`) inherits from the `Image` base class and handles reading and writing raw image data. It manages both the header information and pixel data associated with the image files.\n\n**Role and Purpose**: The primary role of `ImageRAW` is to load and save RAW format images, which typically consist of binary data without a structured metadata or header section beyond basic dimensions and type specifications. This class ensures that raw data can be correctly interpreted by initializing headers and reading/writing pixel values directly.\n\n**Interactions with Other Components**: As part of the `Image` hierarchy, `ImageRAW` interacts primarily through overridden methods (`load`, `save`) which are defined in the base `Image` class. It inherits functionality such as handling image data and managing file operations. The `initHeader` method initializes header information for raw images.\n\n**Practical Usage Guidance**: When using `ImageRAW`, users should ensure that they provide appropriate headers for raw files, if any. Methods like `load` and `save` can be used to read from or write to RAW image files with optional header management through the `initHeader` method. The `getHeaderSize` and `getHeader` methods allow access to header information."
  },
  "maths": {
    "maths": "The `ImageRAW` class in the SOFA framework (`sofa::helper::io`) is primarily responsible for handling raw image data, which includes reading and writing both header information and pixel values. This class does not directly contribute to any governing equations or operators commonly associated with finite element methods (FEM), such as mass matrix $M$, stiffness matrix $K$, internal force vector $\boldsymbol{f}_{\text{int}}$, residual vector $\boldsymbol{R}$, etc. Instead, its role is more aligned with data I/O operations that are peripheral to the core FEM simulation pipeline.\n\n### Governing Equations and Operators\n- **Mass Matrix** $M$: Not applicable; `ImageRAW` does not involve any mass properties or equations of motion.\n- **Stiffness Matrix** $K$: No involvement in stiffness calculations.\n- **Internal Force Vector** $\boldsymbol{f}_{\text{int}}$: No contribution to internal force evaluations.\n- **Residual Vector** $\boldsymbol{R}$: Not involved in residual calculations for FEM simulations.\n\n### Constitutive or Kinematic Laws Involved\n`ImageRAW` does not implement any constitutive laws, strain measures, stress tensors, hyperelastic potentials, damping models, constraint Jacobians, etc. Its primary functions are related to file I/O operations and managing image headers:\n- **Header Management**: The `initHeader`, `getHeaderSize`, and `getHeader` methods manage the header information for raw images.\n\n### Role in Global FEM Pipeline\nThe `ImageRAW` class plays a supportive role outside of the core FEM pipeline, which includes assembly, time integration, nonlinear solve, linear solve, constraint handling, and mapping. Instead, it is used to load and save raw image data, which may be useful for initial conditions or visualization purposes:\n- **Assembly**: Not involved.\n- **Time Integration**: No role in time-stepping schemes.\n- **Nonlinear Solve**: Does not participate in nonlinear solution strategies.\n- **Linear Solve**: Not involved in linear system solutions.\n- **Constraint Handling**: No constraints are managed by `ImageRAW`.\n- **Mapping**: Not used for any mappings within the FEM framework.\n\n### Numerical Methods and Discretization Choices\n`ImageRAW` does not encode any numerical methods or discretization choices typical of FEM simulations. Instead, it provides basic functionality to load raw data from files (using binary read operations) and save raw data to files (binary write operations):\n- **Load Method**: Reads the header and pixel values from a file in RAW format.\n- **Save Method**: Writes the header (if present) and pixel values to a file in RAW format.\n\n### Variational / Lagrangian Mechanics Framework\n`ImageRAW` does not contribute to any variational or Lagrangian mechanics framework. Its primary role is to provide an interface for handling raw image data, which can be useful for input/output operations related to FEM simulations but does not involve the mathematical formulation of continuum mechanics.\n\nIn summary, `ImageRAW` is a utility class that facilitates the reading and writing of raw image files. It does not contribute to any of the core mathematical or physical aspects of FEM simulations."
  },
  "summary": {
    "abstract": "`ImageRAW` manages the loading and saving of RAW format images by initializing headers and reading/writing pixel values directly.",
    "sheet": "# ImageRAW\n\n## Overview\nThe `ImageRAW` class in the SOFA framework (`sofa::helper::io`) inherits from the `Image` base class. It handles reading and writing raw image data, including managing header information and pixel values associated with the image files.\n\n## Parameters and Data\n- **initHeader**: Initializes header information for raw images with a specified size (`hsize`).\n- **getHeaderSize**: Returns the size of the header in bytes as an unsigned integer.\n- **getHeader**: Provides access to the header data as an array of `unsigned char`.\n- **load**: Loads raw image data from a file. The method takes a filename (integer) and returns a boolean indicating success or failure.\n- **save**: Saves raw image data to a file with optional compression level. It takes a filename (integer) and a compression level (integer), returning a boolean for the operation's success."
  }
}