BRSRI/bellande_step

Fork 0

Ronaldson Bellande ceb7c0b03d

Update README.md

2024-09-18 21:24:32 -04:00

11 KiB

Raw Blame History

📦 Bellande Step (Infinite Dimensions)

🧙 Organization Website

🧙 Organization Github

Author, Creator and Maintainer

Ronaldson Bellande

Bellande Step Executables & Models

API HTTP Usability (BELLANDE FORMAT)

# Copyright (C) 2024 Bellande Robotics Sensors Research Innovation Center, Ronaldson Bellande
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# 
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
# GNU General Public License v3.0 or later

url: https://bellande-robotics-sensors-research-innovation-center.org

endpoint_path:
    bellande_step: /api/Bellande_Step/bellande_step_nd

Bellande_Framework_Access_Key: bellande_web_api_opensource

API HTTP Usability (JSON FORMAT)

{
  "license": [
    "Copyright (C) 2024 Bellande Robotics Sensors Research Innovation Center, Ronaldson Bellande",
    "This program is free software: you can redistribute it and/or modify",
    "it under the terms of the GNU General Public License as published by",
    "the Free Software Foundation, either version 3 of the License, or",
    "(at your option) any later version.",
    "",
    "This program is distributed in the hope that it will be useful,",
    "but WITHOUT ANY WARRANTY; without even the implied warranty of",
    "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the",
    "GNU General Public License for more details.",
    "",
    "You should have received a copy of the GNU General Public License",
    "along with this program.  If not, see <https://www.gnu.org/licenses/>.",
    "GNU General Public License v3.0 or later"
  ],
  "url": "https://bellande-robotics-sensors-research-innovation-center.org",
  "endpoint_path": {
    "bellande_step": "/api/Bellande_Step/bellande_step_nd"
  },
  "Bellande_Framework_Access_Key": "bellande_web_api_opensource"
}

API Payload Example

{
    "node0": [0, 0, 0],
    "node1": [100, 100, 100],
    "limit": 75,
    "dimensions": 3,
    "auth": {
      "authorization_key": "bellande_web_api_opensource"
    }
}

🧙 Website Bellande API Testing

Quick Bellande API Testing

curl -X 'POST' \
  'https://bellande-robotics-sensors-research-innovation-center.org/api/Bellande_Step/bellande_step_nd' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "node0": [0, 0, 0],
    "node1": [100, 100, 100],
    "limit": 75,
    "dimensions": 3,
    "auth": {
      "authorization_key": "bellande_web_api_opensource"
    }
  }'

BS(Bellande Step) Algorithm API

Experiment 1 -- Limit = 1

Figure 2D	Figure 3D	Figure 4D
Figure 5D	Figure 6D	Figure 7D
Figure 8D	Figure 9D	Figure 10D

Experiment 2 -- Limit = 25

Figure 2D	Figure 3D	Figure 4D
Figure 5D	Figure 6D	Figure 7D
Figure 8D	Figure 9D	Figure 10D

Experiment 3 -- Limit = 50

Figure 2D	Figure 3D	Figure 4D
Figure 5D	Figure 6D	Figure 7D
Figure 8D	Figure 9D	Figure 10D

Experiment 4 -- Limit = 75

Figure 2D	Figure 3D	Figure 4D
Figure 5D	Figure 6D	Figure 7D
Figure 8D	Figure 9D	Figure 10D

Experiment 5 -- Limit = 100

Figure 2D	Figure 3D	Figure 4D
Figure 5D	Figure 6D	Figure 7D
Figure 8D	Figure 9D	Figure 10D

Check Out Research Organization for open-source/semi-open-source API

https://robotics-sensors.github.io
Check out website for more information avaliable open-source API

API in api_docs

Temporarily Enabled for OpenSource
2D Space
3D Space
4D Space
5D Space
6D Space
7D Space
8D Space
9D Space
10D Space

Can also checkout portion of the docs at Portion API DOCS

✔️ confirmed versions

The step function efficiently computes the next step towards a target node within a specified distance limit.

Usage 2D Space

Suppose you have two nodes representing positions in a 2D space:

node0 at coordinates (0, 0)
node1 at coordinates (5, 5)

You want to compute the next step from node0 towards node1 while limiting the maximum distance to 3 units.

# Define Import 
from bellande_robot_step.bellande_robot_step_2d import bellande_step_2d, Node2D

# Define the nodes
node0 = Node2D(0, 0)
node1 = Node2D(5, 5)

# Compute the next step within a distance limit of 3 units
next_step = bellande_step_2d(node0, node1, limit=3)

# Output the coordinates of the next step
print("Next Step Coordinates:", next_step.coord)

Usage 3D Space

Suppose you have two nodes representing positions in a 3D space:

node0 at coordinates (0, 0, 0)
node1 at coordinates (5, 5, 5)