Methods

{
  "name": "SelectLabelROI",
  "namespace": "sofa::component::engine::select",
  "module": "Sofa.Component.Engine.Select",
  "include": "sofa/component/engine/select/SelectLabelROI.h",
  "doc": "Select a subset of labeled points or cells stored in (vector<svector<label>>) given certain labels.",
  "inherits": [
    "DataEngine"
  ],
  "templates": [
    "int",
    "unsigned char",
    "unsigned int",
    "unsigned short"
  ],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "init",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "reinit",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "doUpdate",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    }
  ],
  "description": "The `SelectLabelROI` component in the SOFA framework is an engine designed to select subsets of labeled points or cells based on specified labels. It inherits from `DataEngine`, which suggests it processes and manipulates data within the simulation scene-graph structure. The primary role of this component is to filter point or cell indices according to a predefined list of labels, effectively creating a region of interest (ROI) based on label matching.\n\nThis component interacts with other components through its input and output fields:\n- Input: `d_labels` (lists of labels associated with each point/cell) and `d_selectLabels` (list of selected labels).\n- Output: `d_indices` (selected point/cell indices).\n\nThe `SelectLabelROI` class implements methods such as `init`, `reinit`, and the protected method `doUpdate`. The `doUpdate` method processes the input data to generate the output indices by checking if any of the labels in each point/cell match those specified for selection.\n\nPractical usage involves specifying the list of labels that define the desired ROI. This component can be used in scenarios where labeled datasets need filtering, such as isolating specific regions or features within a larger dataset for further processing or analysis.",
  "maths": "The `SelectLabelROI` component in the SOFA framework is designed to filter labeled points or cells based on specified labels, creating a region of interest (ROI). This component does not directly contribute to any governing equations or operators used in the Finite Element Method (FEM) simulation pipeline. Instead, it serves as an engine that processes and manipulates data within the scene graph structure.\n\n### Mathematical Description\n\nThe `SelectLabelROI` component operates on a set of labeled points or cells and filters them based on specified labels. The mathematical operations involved are straightforward:\n- **Input Data**:\n  - \\(\\textbf{d\\_labels}\\): A vector where each element is an SVector containing the labels associated with each point/cell.\n  - \\(\\textbf{d\\_selectLabels}\\): A list of selected labels that define the ROI.\n- **Output Data**:\n  - \\(\\textbf{d\\_indices}\\): A vector containing the indices of points or cells whose labels match any label in the `d_selectLabels` list.\n\n### Physical Description\n\nThe physical significance of this component lies in its ability to filter and isolate specific regions within a larger dataset based on predefined criteria. This can be particularly useful for isolating specific features, structures, or regions within a simulation for further analysis or processing. The labels themselves could represent different materials, tissue types, or other physical properties.\n\n### Role in the Global FEM Pipeline\n\nThis component does not directly participate in the assembly phase of the FEM pipeline (e.g., mass matrix \\(\\textbf{M}\\), stiffness matrix \\(\\textbf{K}\\), internal forces \\(\\textbf{f_{int}}\\), or residual \\(\\textbf{R}\\)). Instead, it operates on a higher level within the simulation framework by filtering labeled points or cells. This can be used in preprocessing steps to isolate specific regions before applying FEM simulations.\n\n### Numerical Methods and Discretization Choices\n\nThe component employs simple set operations for efficient look-up of labels. Specifically, it converts the list of selected labels into a set (for faster membership checks) and iterates over each point/cell's labels to check if any label matches those in the `d_selectLabels` set.\n\n### Variational / Lagrangian Mechanics Framework\n\nSince this component is not directly involved in formulating or solving the equations of motion, it does not fit into the variational or Lagrangian mechanics framework. Its role is more about data manipulation and filtering based on label criteria.",
  "abstract": "Filters labeled points or cells based on specified labels, generating a region of interest (ROI) for further processing within the SOFA simulation framework.",
  "sheet": "# SelectLabelROI\n\n## Overview\nThe `SelectLabelROI` component is an engine that filters labeled points or cells based on specified labels to create a region of interest (ROI). It inherits from `DataEngine`, indicating its role in data manipulation and filtering within the scene graph structure.\n\n## Parameters and Data\n- **d_labels**: A vector where each element is an SVector containing the labels associated with each point/cell. This field defines the input labels for filtering.\n- **d_selectLabels**: A list of selected labels that define the ROI. Points or cells whose labels match any label in this list are included in the output indices.\n- **d_indices**: The output vector containing the indices of points or cells whose labels match those specified in `d_selectLabels`."
}