Compute Library
 20.11
IMultiImage.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2019 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_IMULTIIMAGE_H
25 #define ARM_COMPUTE_IMULTIIMAGE_H
26 
27 namespace arm_compute
28 {
29 class ITensor;
30 using IImage = ITensor;
31 class MultiImageInfo;
32 
33 /** Interface for multi-planar images */
35 {
36 public:
37  /** Destructor */
38  virtual ~IMultiImage() = default;
39  /** Interface to be implemented by the child class to return the multi-planar image's metadata
40  *
41  * @return A pointer to the image's metadata.
42  */
43  virtual const MultiImageInfo *info() const = 0;
44  /** Return a pointer to the requested plane of the image.
45  *
46  * @param[in] index The index of the wanted planed.
47  *
48  * @return A pointer pointed to the plane
49  */
50  virtual IImage *plane(unsigned int index) = 0;
51  /** Return a constant pointer to the requested plane of the image.
52  *
53  * @param[in] index The index of the wanted planed.
54  *
55  * @return A constant pointer pointed to the plane
56  */
57  virtual const IImage *plane(unsigned int index) const = 0;
58 };
59 }
60 #endif /*ARM_COMPUTE_IMULTIIMAGE_H */
Store the multi-planar image's metadata.
Interface for NEON tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2020 Arm Limited.
Interface for multi-planar images.
Definition: IMultiImage.h:34
virtual ~IMultiImage()=default
Destructor.
virtual const MultiImageInfo * info() const =0
Interface to be implemented by the child class to return the multi-planar image's metadata.
ITensor IImage
Interface for CPP Images.
virtual IImage * plane(unsigned int index)=0
Return a pointer to the requested plane of the image.