DataConditioner.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed
// under the Mutual Non-Disclosure Agreement.
//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. No third party distribution is allowed unless
// expressly authorized by NVIDIA.  Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2015-2019 NVIDIA Corporation. All rights reserved.
//
// NVIDIA Corporation and its licensors retain all intellectual property and proprietary
// rights in and to this software and related documentation and any modifications thereto.
// Any use, reproduction, disclosure or distribution of this software and related
// documentation without an express license agreement from NVIDIA Corporation is
// strictly prohibited.
//

#ifndef DW_DNN_DATACONDITIONER_H_
#define DW_DNN_DATACONDITIONER_H_

#include <dw/core/context/Context.h>
#include <dw/core/base/Types.h>
#include <dw/image/Image.h>
#include <dw/dnn/tensor/Tensor.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct dwDataConditionerParams
{
    float32_t meanValue[DW_MAX_IMAGE_PLANES];
    float32_t stdev[DW_MAX_IMAGE_PLANES];
    const dwImageCUDA* meanImage;
    bool splitPlanes;
    float32_t scaleCoefficient;
    bool ignoreAspectRatio;
    bool doPerPlaneMeanNormalization;
} dwDataConditionerParams;

typedef struct dwDataConditionerObject* dwDataConditionerHandle_t;

DW_API_PUBLIC
dwStatus dwDataConditioner_initParams(dwDataConditionerParams* const dataConditionerParams);

DW_API_PUBLIC
DW_DEPRECATED("WARNING: dwDataConditioner_initialize() will be removed in the next major "
              "release. Please use dwDataConditioner_initializeNew() instead.")
dwStatus dwDataConditioner_initialize(dwDataConditionerHandle_t* const obj,
                                      dwBlobSize const* const networkInputBlobSize,
                                      dwDataConditionerParams const* const dataConditionerParams,
                                      cudaStream_t const stream, dwContextHandle_t const ctx);

DW_API_PUBLIC
dwStatus dwDataConditioner_initializeNew(dwDataConditionerHandle_t* const obj,
                                         dwBlobSize const* const networkInputBlobSize,
                                         uint32_t const maxNumImages,
                                         dwDataConditionerParams const* const dataConditionerParams,
                                         cudaStream_t const stream, dwContextHandle_t const ctx);

DW_API_PUBLIC
dwStatus dwDataConditioner_initializeFromTensorProperties(dwDataConditionerHandle_t* const obj,
                                                          dwDNNTensorProperties const* const outputProperties,
                                                          uint32_t const maxNumImages,
                                                          dwDataConditionerParams const* const dataConditionerParams,
                                                          cudaStream_t const stream, dwContextHandle_t const ctx);

DW_API_PUBLIC
dwStatus dwDataConditioner_setCUDAStream(cudaStream_t const stream, dwDataConditionerHandle_t const obj);

DW_API_PUBLIC
dwStatus dwDataConditioner_getCUDAStream(cudaStream_t* const stream, dwDataConditionerHandle_t const obj);

DW_API_PUBLIC
dwStatus dwDataConditioner_reset(dwDataConditionerHandle_t const obj);

DW_API_PUBLIC
dwStatus dwDataConditioner_release(dwDataConditionerHandle_t const obj);

DW_API_PUBLIC
dwStatus dwDataConditioner_prepareDataRaw(float32_t* const dOutputImage, dwImageCUDA const* const* const inputImages,
                                          uint32_t const numImages, dwRect const* const roi,
                                          cudaTextureAddressMode const addressMode, dwDataConditionerHandle_t const obj);

DW_API_PUBLIC
dwStatus dwDataConditioner_prepareData(dwDNNTensorHandle_t const tensorOutput,
                                       dwImageHandle_t const* const inputImages,
                                       uint32_t const numImages, dwRect const* const roi,
                                       cudaTextureAddressMode const addressMode, dwDataConditionerHandle_t const obj);

DW_API_PUBLIC
dwStatus dwDataConditioner_getOutputSize(dwBlobSize* const outputBlobSize,
                                         dwDataConditionerHandle_t const obj);

DW_API_PUBLIC
dwStatus dwDataConditioner_outputPositionToInput(float32_t* const outputX, float32_t* const outputY,
                                                 float32_t const inputX, float32_t const inputY,
                                                 dwRect const* const roi, dwDataConditionerHandle_t const obj);
#ifdef __cplusplus
}
#endif

#endif // DW_DNN_DATACONDITIONER_H_