# Welcome

Welcome to the Rasterscan! Here you'll get an overview of all the amazing features GitBook offers to help you build beautiful, interactive documentation.

Rasterscan has built one AI model for drawing floor plan from raster images. The model identifies walls and windows, doors automatically, and so it will make much easier to use your floor plan drawing program for the customers.


# Installation

Rasterscan offers a quick and easy way to deploy the Floor Plan Recognition service using Docker. Follow the steps below to get started

**Prerequisites**

* Docker must be installed on your system.

**Installation Steps**

* Pull the latest Docker image:

`sudo docker pull rasterscan/floor-plan-recognition:latest-cpu`

* Run the container:

`sudo docker run --name rasterscan-service -d -p 8888:8888 rasterscan/floor-plan-recognition:latest-cpu`

**Access the Service**

Once running, the service will be available at:

{% embed url="<http://localhost:8888>" %}

**Support**

If you encounter any issues during installation, please contact <contact@rasterscan.com> or refer to our troubleshooting guide.


# ChangeLog

Once you’ve finished writing, editing, or importing your content, you can publish your work to the web as a docs site. Once published, your site will be accessible online only to your selected audience.

You can publish your site and find related settings from your docs site's homepage.

<figure><img src="https://gitbookio.github.io/onboarding-template-images/publish-hero.png" alt=""><figcaption></figcaption></figure>


# Editor

GitBook has a powerful block-based editor that allows you to seamlessly create, update, and enhance your content.

<figure><img src="https://gitbookio.github.io/onboarding-template-images/editor-hero.png" alt=""><figcaption></figcaption></figure>

### Writing content

GitBook offers a range of block types for you to add to your content inline — from simple text and tables, to code blocks and more. These elements will make your pages more useful to readers, and offer extra information and context.

Either start typing below, or press `/` to see a list of the blocks you can insert into your page.


# Markdown

GitBook supports many different types of content, and is backed by Markdown — meaning you can copy and paste any existing Markdown files directly into the editor!

<figure><img src="https://gitbookio.github.io/onboarding-template-images/markdown-hero.png" alt=""><figcaption></figcaption></figure>

Feel free to test it out and copy the Markdown below by hovering over the code block in the upper right, and pasting into a new line underneath.

```markdown
# Heading

This is some paragraph text, with a [link](https://docs.gitbook.com) to our docs. 

## Heading 2
- Point 1
- Point 2
- Point 3
```

{% hint style="info" %}
If you have multiple files, GitBook makes it easy to import full repositories too — allowing you to keep your GitBook content in sync.
{% endhint %}


# Images & media

GitBook allows you to add images and media easily to your docs. Simply drag a file into the editor, or use the file manager in the upper right corner to upload multiple images at once.

<figure><img src="https://gitbookio.github.io/onboarding-template-images/images-hero.png" alt=""><figcaption><p>Add alt text and captions to your images</p></figcaption></figure>

{% hint style="info" %}
You can also add images simply by copying and pasting them directly into the editor — and GitBook will automatically add it to your file manager.
{% endhint %}


# Interactive blocks

In addition to the default Markdown you can write, GitBook has a number of out-of-the-box interactive blocks you can use. You can find interactive blocks by pressing `/` from within the editor.

<figure><img src="https://gitbookio.github.io/onboarding-template-images/interactive-hero.png" alt=""><figcaption></figcaption></figure>

### Tabs

{% tabs %}
{% tab title="First tab" %}
Each tab is like a mini page — it can contain multiple other blocks, of any type. So you can add code blocks, images, integration blocks and more to individual tabs in the same tab block.
{% endtab %}

{% tab title="Second tab" %}
Add images, embedded content, code blocks, and more.

```javascript
const handleFetchEvent = async (request, context) => {
    return new Response({message: "Hello World"});
};
```

{% endtab %}
{% endtabs %}

### Expandable sections

<details>

<summary>Click me to expand</summary>

Expandable blocks are helpful in condensing what could otherwise be a lengthy paragraph. They are also great in step-by-step guides and FAQs.

</details>

### Drawings

<img alt="" class="gitbook-drawing">

### Embedded content

{% embed url="<https://www.youtube.com/watch?v=YILlrDYzAm4>" %}

{% hint style="info" %}
GitBook supports thousands of embedded websites out-of-the-box, simply by pasting their links. Feel free to check out which ones[ are supported natively](https://iframely.com).
{% endhint %}


# Integrations

GitBook integrations allow you to connect your GitBook spaces to some of your favorite platforms and services. You can install integrations into your GitBook page from the *Integrations* menu in the top left.

<figure><img src="https://gitbookio.github.io/onboarding-template-images/integrations-hero.png" alt=""><figcaption></figcaption></figure>

### Types of integrations

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th></tr></thead><tbody><tr><td><strong>Analytics</strong></td><td>Track analytics from your docs</td><td><a href="https://www.gitbook.com/integrations#analytics">https://www.gitbook.com/integrations#analytics</a></td><td><a href="https://content.gitbook.com/content/D1wdTONrZCXNvAQDxu89/blobs/KHeXsCXVz7BFriKxx7qC/2.png">2.png</a></td><td></td></tr><tr><td><strong>Support</strong></td><td>Add support widgets to your docs</td><td><a href="https://www.gitbook.com/integrations#support">https://www.gitbook.com/integrations#support</a></td><td><a href="https://content.gitbook.com/content/D1wdTONrZCXNvAQDxu89/blobs/fyYKbWZc5X1ZPhiMbDWC/3.png">3.png</a></td><td></td></tr><tr><td><strong>Interactive</strong></td><td>Add extra functionality to your docs</td><td><a href="https://www.gitbook.com/integrations#interactive">https://www.gitbook.com/integrations#interactive</a></td><td><a href="https://content.gitbook.com/content/D1wdTONrZCXNvAQDxu89/blobs/ESJU8ZFcSX1S0gcPwvQf/4.png">4.png</a></td><td></td></tr><tr><td><strong>Visitor Authentication</strong></td><td>Protect your docs and require sign-in</td><td><a href="https://www.gitbook.com/integrations#visitor-authentication">https://www.gitbook.com/integrations#visitor-authentication</a></td><td><a href="https://content.gitbook.com/content/D1wdTONrZCXNvAQDxu89/blobs/WBM53p7vN0ijqGZsH08z/1.png">1.png</a></td><td></td></tr></tbody></table>


# Rasterscan

## GET /health

> Check health

```json
{"openapi":"3.0.0","info":{"title":"Rasterscan","version":"1.0.0"},"servers":[{"url":"http://{{base_url}}"}],"paths":{"/health":{"get":{"tags":["default"],"summary":"Check health","responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## GET /get\_machine\_code

> Get Machine Code

```json
{"openapi":"3.0.0","info":{"title":"Rasterscan","version":"1.0.0"},"servers":[{"url":"http://{{base_url}}"}],"paths":{"/get_machine_code":{"get":{"tags":["default"],"summary":"Get Machine Code","responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## POST /activate\_machine

> Activate Machine

```json
{"openapi":"3.0.0","info":{"title":"Rasterscan","version":"1.0.0"},"servers":[{"url":"http://{{base_url}}"}],"paths":{"/activate_machine":{"post":{"tags":["default"],"summary":"Activate Machine","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## POST /plan\_recognition

> Recognize floor plan using raw file

```json
{"openapi":"3.0.0","info":{"title":"Rasterscan","version":"1.0.0"},"servers":[{"url":"http://{{base_url}}"}],"paths":{"/plan_recognition":{"post":{"tags":["default"],"summary":"Recognize floor plan using raw file","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```

## POST /plan\_recognition\_on\_base64

> Recognize floor plan using base64 image data

```json
{"openapi":"3.0.0","info":{"title":"Rasterscan","version":"1.0.0"},"servers":[{"url":"http://{{base_url}}"}],"paths":{"/plan_recognition_on_base64":{"post":{"tags":["default"],"summary":"Recognize floor plan using base64 image data","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{}}}}}}}}
```