perception/object/camera/lightsourcenet/docs/lightsourcenet_usecase1.md

Go to the documentation of this file.

# Copyright (c) 2019-2020, NVIDIA CORPORATION.  All rights reserved.

@page lightsourcenet_usecase1 LightSourceNet Workflow

## Initialization

The LightSourceNet module creates handles of type `dwLightSourceNetHandle_t`, which is owned by the application and must be released by the application when not needed anymore.

An instance of type `dwLightSourceNetParams` encodes parameters (currently only network precision) that configure the LightSourceNet module. To initialize default LightSourceNet parameters:

```{.cpp}
dwStatus dwLightSourceNet_initDefaultParams(dwLightSourceNetParams* params);
```

To initialize a pointer to a `dwLightSourceNetHandle_t` instance with default parameter values:

```{.cpp}
dwStatus dwLightSourceNet_initialize(dwLightSourceNetHandle_t* lightSourceNetHandle,
                                     const dwLightSourceNetParams* lightSourceNetParams,
                                     dwContextHandle_t ctx);
```

An example code snippet to initialize required modules with default values:

```{.cpp}
// Initialize LightSourceNet
dwLightSourceNetHandle_t m_lightSourceNet = DW_NULL_HANDLE;
dwLightSourceNetParams m_lightSourceNetParams;

CHECK_DW_ERROR(dwLightSourceNet_initDefaultParams(&m_lightSourceNetParams));
CHECK_DW_ERROR(dwLightSourceNet_initialize(&m_lightSourceNet, &m_lightSourceNetParams, m_sdk));
```

where `m_sdk` is an initialized instance of `dwContextHandle_t`.

The initialized handle of LightSourceNet is used to initialize LightSourceDetector module.

## Query Network Specs

With initialized handle to the LightSourceNet module, the following functions can be used to query size of expected input blob, size of output blob and network metadata respectively:

```{.cpp}
dwStatus dwLightSourceNet_getInputBlobSize(dwBlobSize* inputBlobsize, dwLightSourceNetHandle_t lightSourceNetHandle);
```

```{.cpp}
dwStatus dwLightSourceNet_getOutputBlobSize(dwBlobSize* outputBlobsize, dwLightSourceNetHandle_t lightSourceNetHandle);
```

```{.cpp}
dwStatus dwLightSourceNet_getDNNMetaData(dwDNNMetaData* metaData, dwLightSourceNetHandle_t lightSourceNetHandle);
```

## Use for Inference and Post-processing

The LightSourceNet is closely coupled with LightSourceDetector. The neural network inference and post-processing is executed via LightSourceDetector APIs.

## Reset and Release

The following functions can be used to reset or release the initialized module handles:

```{.cpp}
dwStatus dwLightSourceNet_reset(dwLightSourceNetHandle_t lightSourceNetHandle);
```

```{.cpp}
dwStatus dwLightSourceNet_release(dwLightSourceNetHandle_t lightSourceNetHandle);
```

##Relevant Tutorials

For usage of a sample application, please refer to @ref dwx_lightsourceperception_sample.