API Reference Manual

Copyrightⓒ 2020 / SEONGSAN INC

This manual is protected under national and international copyright laws.

No part of this manual may be reproduced, distributed, translated, or transmitted in any form or by any means electronic or mechanical, including but not limited to photocopying, recording, or storing in any information storage and retrieval system without prior written permission of SEONGSAN LAB INC.

All rights reserved

If this document is distributed with software containing the end-user agreement, this manual and the software described herein are licensed and may only be used or copied in accordance with the terms of the license. Unless permitted by such license, no part of this guide may be reproduced, stored or transmitted in any form or means (e.g., electronics, machinery, recording, etc.) without prior written approval from SEONGSAN LAB INC. The contents of this manual are protected by copyright law even if it is not distributed with software containing an end-user license agreement.

The contents of this guide are provided for informational purposes only, subject to change without prior notice, and shall not be used as any part of the agreement or contract of SEONGSAN LAB INC, which shall not be liable for any errors or inaccuracies in the information contained in this guide. Existing illustrations or images that you wish to include in your project may be protected by copyright law. You must obtain permission from the copyright owner.

References to company names, company logos, and user names in sample materials or sample forms included in this manual and/or software are solely for its purpose and do not refer to any actual organization or person. DEEPSOUND is a registered trademark of Seongsan Research Institute in Korea and is the property of its owner.

Disclaimer

SEONGSAN LAB INC, 2020. Ver 1.0. *All information in this document is subject to change without prior notice.

DSK Change Log:

Table of Contents

INTRODUCTION

This Document explains the API of DSK. All the API of DSK are in the format of DSK.XXX where XXX represents functions. These functions are largely divided into categories such as Init, Get, Set, Upload, etc.

Use the Get functions to get DSK’s parameters, and the Set function to set those parameters. In order to use the Set function to actually set parameters, the UploadAllParameters function must be called.

Calling the UploadAllParameters function to set the DSK parameters is a time consuming process. To expedite this process, use the UploadXXX function for individual parameters.

For example, you can set the Gain value with either one of the following two methods. If Gain is the only value that changed, the two methods perform the same action, but the second method is faster.

Only the frequently used parameters have a dedicated Upload function.

Unless specified otherwise, DSK uses mm for lengths, degrees for angles, Hz for frequencies, and seconds as the unit of time.

Init Functions

There are two types of Init functions: InitDsk and InitDevice. InitDsk is the first function that must be called in order to use DSK, and InitDevice is used to initialize the hardware to generate an image.

CloseDevice is called to close the program.

Get Functions

Get scan image parameters

Unlike A scan, B scan, and C scan, S Scan Mode changes the image width through scan conversion depending on the image parameters. In other words, if you change the image parameters, use the methods listed above to obtain the width and height, and display the image on the screen after color mapping.

GetSScanWidth

GetSScanHeight

This is to make sure the entire area of the width and height calculated by S Scan Image goes through scan conversion. Additionally, the byte array returned by CalcSScanImage is equal to the product of SScanWidth and SScanHeight.

Set Functions

Set Callback functions

DECLARATION

void DSK.SetCallBackFrame(DskCallBackFrame func)

void DSK.SetCallBackFrame(DskCallBackFrameX func)

void DSK.SetCallBackFrame(DskCallBackFrameXY func)

void DSK.SetCallBackFrame(DskCallBackFrameXYZ func)

void DSK.SetCallBackFrame(DskCallBackFrameMultiBoardXYZ func)

DESCRIPTION

Sets the Callback method. You must pass in one of the delegate methods listed below in the NOTES section to the input. Depending on the type of encoder location you need, only call the method once.

PARAMETERS

Delegate methods are categorized depending on the encoder coordinates it is trying to receive.

RETURN VALUE

None

NOTE

public delegate void DskCallBackFrame(short[] frameData);

public delegate void DskCallBackFrameX(short[] frameData, double locX);

public delegate void DskCallBackFrameXY(short[] frameData, double locX, double locY); public delegate void DskCallBackFrameXYZ(short[] frameData, double locX, double locY, double locZ);

public delegate void DskCallBackFrameMultiBoardXYZ(int boardId, short[] frameData, double locX, double locY, double locZ);

All location information is in mm.

Upload Functions

Additional Functions

Calc S Scan Image

In order to display the S Scan Image, it must go through scan conversion. Calling this method using the frame data obtained from the Callback method will return the data that has been scan converted. Pass in the short array into the input to return the scan converted byte array. Since the returned value is a byte value, it must go through color mapping and be converted into a color image before displaying onto the screen.