Perception Tool Kit (PTK) API Guide
median_filter.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (c) 2020 Texas Instruments Incorporated
4  *
5  * All rights reserved not granted herein.
6  *
7  * Limited License.
8  *
9  * Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
10  * license under copyrights and patents it now or hereafter owns or controls to make,
11  * have made, use, import, offer to sell and sell ("Utilize") this software subject to the
12  * terms herein. With respect to the foregoing patent license, such license is granted
13  * solely to the extent that any such patent is necessary to Utilize the software alone.
14  * The patent license shall not apply to any combinations which include this software,
15  * other than combinations with devices manufactured by or for TI ("TI Devices").
16  * No hardware patent is licensed hereunder.
17  *
18  * Redistributions must preserve existing copyright notices and reproduce this license
19  * (including the above copyright notice and the disclaimer and (if applicable) source
20  * code license limitations below) in the documentation and/or other materials provided
21  * with the distribution
22  *
23  * Redistribution and use in binary form, without modification, are permitted provided
24  * that the following conditions are met:
25  *
26  * * No reverse engineering, decompilation, or disassembly of this software is
27  * permitted with respect to any software provided in binary form.
28  *
29  * * any redistribution and use are licensed by TI for use only with TI Devices.
30  *
31  * * Nothing shall obligate TI to provide you with source code for the software
32  * licensed and provided to you in object code.
33  *
34  * If software source code is provided to you, modification and redistribution of the
35  * source code are permitted provided that the following conditions are met:
36  *
37  * * any redistribution and use of the source code, including any resulting derivative
38  * works, are licensed by TI for use only with TI Devices.
39  *
40  * * any redistribution and use of any object code compiled from the source code
41  * and any resulting derivative works, are licensed by TI for use only with TI Devices.
42  *
43  * Neither the name of Texas Instruments Incorporated nor the names of its suppliers
44  *
45  * may be used to endorse or promote products derived from this software without
46  * specific prior written permission.
47  *
48  * DISCLAIMER.
49  *
50  * THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY EXPRESS
51  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53  * IN NO EVENT SHALL TI AND TI'S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT,
54  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
55  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
57  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
58  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
59  * OF THE POSSIBILITY OF SUCH DAMAGE.
60  *
61  */
62 #ifndef _MEDIAN_FILTER_H
63 #define _MEDIAN_FILTER_H
64 
65 #include <perception/perception.h>
68 
80 typedef struct
81 {
83  int16_t width;
84 
86  int16_t height;
87 
89  int16_t filterSize;
90 
92 
93 
98 typedef struct
99 {
102 
103  int16_t * buffer;
104 
105  int16_t * tmpBuffer;
106 
108 
122 
147  PTK_Api_MemoryReq * memReq);
148 
164  const PTK_Api_MemoryRsp * memRsp);
165 
178 
192  int16_t * disparityBuffer,
193  int16_t * outDisparityBuffer,
194  int16_t stride);
195 
196 
197 
198 #endif // #ifndef _MEDIAN_FILTER_H
Stereo Post-Processing 2-D median filter algorithm - config Parameters.
Definition: median_filter.h:80
int16_t filterSize
Definition: median_filter.h:89
void * PTK_AlgHandle
Algorithm Handle.
Definition: alg_common.h:79
int16_t height
Definition: median_filter.h:86
int16_t * buffer
Definition: median_filter.h:103
int32_t PTK_Alg_StereoPP_MedianFilterConfig(PTK_Alg_StereoPP_MedianFilter_configParams *cfg, PTK_Api_MemoryReq *memReq)
Computes the memory requirements based on the given algorithm configuration parameters.
PTK_AlgHandle PTK_Alg_StereoPP_MedianFilterInit(PTK_Alg_StereoPP_MedianFilter_configParams *cfg, const PTK_Api_MemoryRsp *memRsp)
Initializes the library based on the given algorithm configuration parameters and allocated memory bl...
int16_t * tmpBuffer
Definition: median_filter.h:105
API memory allocation response.
Definition: api_memory_if.h:158
int32_t PTK_Alg_StereoPP_MedianFilterGetMem(PTK_Alg_StereoPP_MedianFilterObj *cntxt, uint8_t *memPtr)
Get memory size.
PTK_Alg_StereoPP_MedianFilter_configParams cfgParams
Definition: median_filter.h:101
API memory allocation request.
Definition: api_memory_if.h:125
void PTK_Alg_StereoPP_runMedianFilter(PTK_Alg_StereoPP_MedianFilterObj *cntxt, int16_t *disparityBuffer, int16_t *outDisparityBuffer, int16_t stride)
Run 2-D median filter.
int16_t width
Definition: median_filter.h:83
void PTK_Alg_StereoPP_MedianFilterSetParams(PTK_Alg_StereoPP_MedianFilter_configParams *cfg, PTK_Alg_StereoPP_MedianFilterObj *cntxt)
Initialize median filter parameters.
Stereo algorithm - 2-D median filter context.
Definition: median_filter.h:98