FindSurface Request for Web

1. HTTP Request URL

${findType} must be replaced with one of following feature types:

• plane
• sphere
• cylinder
• cone
• torus

Generally, FindSurface provides a response as binary format.
If you attach .json at the end of requested URL above, server will provide a response as JSON format.

Request Example

1. Request Find Plane with binary format response

   https://developers.curvsurf.com/FindSurface/plane

2. Request Find Torus with JSON format response

   https://developers.curvsurf.com/FindSurface/torus.json

2. HTTP Request Header

Required Fields

Optional Fields

NOTE: To use optional header field(s) below, Content-Type must be set to application/x-findsurface-request.

• If Content-Encoding is presented, it lets the server knows a request body is deflated with zlib.

• If X-Content-Endian is presented, it lets the server knows a byte order of a request body as Big-endian. Otherwise, as Little-endian.

• If X-Accept-Endian is presented, it lets the server knows the client wants a byte order of a response body as Big-endian. Otherwise, as Little-endian.
  Note that, X-Accept-Endian is ignored when response format is in JSON format.

3. HTTP Request Body Format

Request body consists of two parts: Header and Array of Point Attributes.

NOTE: Point Attributes must contains Position Attribute, which is a 3-dimensional vector.

Byte Table of Request Body

3.1. Body Header Description

Signature uint8_t[2]

"FS" : Signature bytes. [0] = 'F'; [1] = 'S'

Version uint8_t[2]

Version. [0] = major, [1] = minor
Current version is 1.0 ( major = 1, minor = 0 )

Header Size uint32_t

Byte size of this header.
40 ( for ver. 1.0 )

Point Count uint32_t

The number of Point Attributes in the array.

Point Offset uint32_t

A byte offset of the first position component of the first Point Attributes in the array.

**Please refer to Example 2 below.

Point Stride uint32_t

Byte offset between consecutive Point Attributes. If this value is 0, Point Attributes are understood to be tightly packed a 3-dimensional vector in the array.

**Please refer the examples below for the details.

Measurement Accuracy float (IEEE754 Single)

Point measurement accuracy.

Mean Distance float (IEEE754 Single)

Mean distance of neighboring points.

Touch Radius float (IEEE754 Single)

Radius of seed region.

Seed Index uint32_t

The index number of the interest point to recognize the specific surface.

Find Type uint8_t

Reserved.
This parameter is currently not used. Find Type is specified on a request URL.
This value must be set to '0'.

Rad. Exp. uint8_t

Radial Expansion: Level of segmentation referenced to the direction of the surface normal.

 0        1        -----        5        -----        10
off    moderate              default
                          (recommanded)         radical expansion

Lat. Ext. uint8_t

Lateral Extension: Level of region growing in lateral direction. (for plane, cylinder, cone)

 0        1        -----        5        -----        10
off    moderate              default
                          (recommanded)         radical extension

Option Flags uint8_t

Additional options specified in a combination of the following constants with or( | ) operator:

• 0x01 - Set this flag if you want to get inlier and outlier flags on a response body.
• 0x02 - Set this flag if position attribute of Point Attributes in a request body uses double precision floating point numbers.
  **By default, poisition attribute of Point Attributes in a request body is considered as single precision floating point numbers.

or 0x00 for not to use any option.

3.2. Body Data Example

Example 1

Suppose we have Point Attributes array of which each attribute contains position attribute (single precision) only. Such Point Attributes can be defined as C-like style code below:

typedef struct{ float x, y, z; } PointAttributes;

And also we have following conditions:

• Points are measured with a device, which has 3 mm ( 0.003 m ) measurement error.
• Measurement unit is in meter.
• An average distance between each neighboring point is 5 cm ( 0.05 m ).
  **roughly estimated value
• There are 100 points.
• Our ROI (Region of Interest) has following condition:
  • Seed point is 32nd point from Point Attributes array.
  • Its radius is 20 cm ( 0.2 m )

Example 2

Suppose we have Point Attributes such as below (C-like style code):

typedef struct {
	uint32_t uniqueId;
	double x, y, z;
	uint32_t color;
} PointAttributes;

And also we have following conditions:

• Points are measured with a device, which has 3 mm ( 0.003 m ) measurement error.
• Measurement unit is in meter.
• An average distance between each neighboring point is 5 cm ( 0.05 m ).
  **roughly estimated value
• There are 100 points.
• Our ROI (Region of Interest) has following condition:
  • Seed point is 32nd point from Point Attributes array.
  • Its radius is 20 cm ( 0.2 m )