# Copyright 2021 Zilliz. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import numpy as np
[docs]class Image(np.ndarray):
"""
This class represents an image object. The image data is a numpy.ndarray.
Agrs:
mode (`str`):
The mode of the image(i.e. 'RGB', 'BGR', 'RGBA', 'HSV', etc.).
"""
def __new__(cls, data: np.ndarray, mode: str = None):
# Cast `np.ndarray` to be `Image`.
# See https://numpy.org/doc/stable/user/basics.subclassing.html for details.
obj = np.asarray(data).view(cls)
obj._mode = mode
return obj
def __array_finalize__(self, obj):
# `self` is a new object resulting from super().__new__(cls, ...), therefore it
# only has attributes that the ndarray.__new__ constructor gave it -
# i.e. those of a standard ndarray.
if obj is None:
return
self._mode = getattr(obj, '_mode', None)
def __str__(self):
return 'Image' + ' shape=' + str(self.shape) + ' mode=' + self.mode
def __reduce__(self):
# Get numpy pickle
pickled_state = super(Image, self).__reduce__() #pylint: disable=super-with-arguments
# Attach the attributes to the numpy pickle
new_state = pickled_state[2] + (self.__dict__,)
return (pickled_state[0], pickled_state[1], new_state)
def __setstate__(self, state):
# Set attributes from the pickle
self.__dict__.update(state[-1])
# Call the parent's __setstate__ with the other tuple elements.
super(Image, self).__setstate__(state[0:-1]) #pylint: disable=super-with-arguments
@property
def mode(self):
return self._mode
@property
def width(self):
return self.shape[1]
@property
def height(self):
return self.shape[0]
@property
def channel(self):
return self.shape[2] if len(self.shape) >= 3 else 1
