RawSample

Классы
class	face_sdk.modules.raw_sample.Angles
	Углы ориентации лица. Подробнее...
class	face_sdk.modules.raw_sample.ImageFormat
	Форматы изображения для сохранения (сериализации). Подробнее...
class	face_sdk.modules.raw_sample.SampleType
	Типы образцов (см. Подробнее...
class	face_sdk.modules.raw_sample.FaceCutType
	Типы обрезки лица. Подробнее...
class	face_sdk.modules.raw_sample.RawSample
	Интерфейсный объект, хранящий образец лица. Подробнее...

Функции
def	face_sdk.modules.raw_sample.Angles.__init__
	Угол поворота вокруг вертикальной оси в градусах. Подробнее...
def	face_sdk.modules.raw_sample.RawSample.get_left_eye
	Получить позицию левого глаза. Подробнее...
def	face_sdk.modules.raw_sample.RawSample.get_right_eye
	Получить позицию правого глаза. Подробнее...
def	face_sdk.modules.raw_sample.RawSample.get_rectangle
	Получить ограничивающий прямоугольник лица. Подробнее...
def	face_sdk.modules.raw_sample.RawSample.get_landmarks
	Получить антропометрические точки лица. Подробнее...
def	face_sdk.modules.raw_sample.RawSample.get_iris_landmarks
	Получить характерные точки глаз. Подробнее...
def	face_sdk.modules.raw_sample.RawSample.get_angles
	Получить углы ориентации лица. Подробнее...
def	face_sdk.modules.raw_sample.RawSample.has_original_image
	Хранит ли образец оригинальное изображение, с которого он был получен (True для образцов, полученных с помощью VideoWorker с включенным параметром store_original_frame_in_raw_sample). Подробнее...
def	face_sdk.modules.raw_sample.RawSample.get_score
	Получить уверенность детектирования лица (для образцов, полученных с помощью поддерживаемого Capturer). Подробнее...
def	face_sdk.modules.raw_sample.RawSample.get_face_visibility_score
	Получить оценку видимости лица. Подробнее...
def	face_sdk.modules.raw_sample.RawSample.get_type
	Получить тип образца. Подробнее...
def	face_sdk.modules.raw_sample.RawSample.get_frame_id
	Получить ID кадра, на котором был обнаружен образец (для образцов, полученных с помощью VideoWorker). Подробнее...
def	face_sdk.modules.raw_sample.RawSample.get_id
	Получить целочисленный идентификатор. Подробнее...
def	face_sdk.modules.raw_sample.RawSample.cut_face_image
	Обрезать лицо и сохранить в указанном формате. Подробнее...
def	face_sdk.modules.raw_sample.RawSample.cut_face_raw_image
	Обрезать лицо и выдать в формате RawImage (с декодированными пикселями). Подробнее...
def	face_sdk.modules.raw_sample.RawSample.save
	Сохранить (сериализовать) образец. Подробнее...
def	face_sdk.modules.raw_sample.RawSample.get_face_cut_rectangle
	Получить прямоугольник (для предпросмотра обрезки). Подробнее...
def	face_sdk.modules.raw_sample.RawSample.save_without_image
	Сохранить (сериализовать) всю информацию, кроме изображения. Подробнее...
def	face_sdk.modules.raw_sample.RawSample.get_original_image
	Получить оригинальное изображение. Подробнее...
def	face_sdk.modules.raw_sample.RawSample.downscale_to_preferred_size
	Создать копию образца с внутренним изображением лица, уменьшенным до желаемого размера и без оригинального изображения. Подробнее...
def	face_sdk.modules.raw_sample.RawSample.to_context
	преобразет RawSample в контейнер-Context. Подробнее...

Подробное описание

Функции

def face_sdk.modules.raw_sample.Angles.__init__	(		self,
			yaw
	)

Угол поворота вокруг вертикальной оси в градусах.

Угол поворота вокруг горизонтальной оси в градусах.

Угол поворота в картинной плоскости в градусах.

def face_sdk.modules.raw_sample.RawSample.cut_face_image	(		self,
			binary_stream
	)

Обрезать лицо и сохранить в указанном формате.

Потокобезопасный.

Аргументы

[in]	binary_stream	Поток для сохранения закодированного изображения. Поток файла (BytesIO).
[in]	format	Формат для сохранения изображения.
[in]	cut_type	Тип обрезки.

def face_sdk.modules.raw_sample.RawSample.cut_face_raw_image	(		self,
			color_model
	)

Обрезать лицо и выдать в формате RawImage (с декодированными пикселями).

Потокобезопасный.

Аргументы

[in]	color_model	Цветовая модель изображения.
[in]	cut_type	Тип обрезки.

Возвращает

RawImage c кропом лица

def face_sdk.modules.raw_sample.RawSample.downscale_to_preferred_size

(

self

)

Создать копию образца с внутренним изображением лица, уменьшенным до желаемого размера и без оригинального изображения.

В целях уменьшения потребления памяти (как в оперативной памяти, так и после сериализации).
При работе Capturer и VideoWorker автоматически уменьшают все образцы, если параметр downscale_rawsamples_to_preferred_size включен (включен по умолчанию), но это снижает производительность.
Поэтому лучше отключать downscale_rawsamples_to_preferred_size, и использовать RawSample.downscaleToPreferredSize вручную для образцов, которые вам нужно сохранить или длительно удерживать в оперативной памяти.

Возвращает

Созданный RawSample.

def face_sdk.modules.raw_sample.RawSample.get_angles	(		self,
			Angles
	)

Получить углы ориентации лица.

Только для фронтальных образцов. Потокобезопасный.

Возвращает

Углы ориентации лица.

def face_sdk.modules.raw_sample.RawSample.get_face_cut_rectangle	(		self,
			cut_type
	)

Получить прямоугольник (для предпросмотра обрезки).

Потокобезопасный.

Возвращает

4 точки - углы прямоугольника в порядке против часовой стрелки, начиная с левого верхнего угла.

Аргументы

[in]

cut_type

Тип обрезки.

def face_sdk.modules.raw_sample.RawSample.get_face_visibility_score	(		self,
			float
	)

Получить оценку видимости лица.

Потокобезопасный.

\return Один, если лицо полностью видимо,
        ноль, если лицо невидимо,
        иначе - число в диапазоне [0 ... 1]. 

def face_sdk.modules.raw_sample.RawSample.get_frame_id	(		self,
			int
	)

Получить ID кадра, на котором был обнаружен образец (для образцов, полученных с помощью VideoWorker).

Потокобезопасный.

Возвращает

Ноль, если образец был получен не через VideoWorker,
иначе - неотрицательное целое число - идентификатор (который был возвращен методом VideoWorker.add_video_frame) кадра, на котором был обнаружен образец.

def face_sdk.modules.raw_sample.RawSample.get_id	(		self,
			int
	)

Получить целочисленный идентификатор.

Потокобезопасный.

Возвращает

- Неотрицательное число, если образец был получен с помощью трекера, или

• Любое отрицательное число в противном случае.

def face_sdk.modules.raw_sample.RawSample.get_iris_landmarks	(		self,
			List,
			Point
	)

Получить характерные точки глаз.

Только для фронтальных образцов. Потокобезопасный.

Возвращает

Вектор позиций точек зрачков и контуров век на оригинальном изображении.

def face_sdk.modules.raw_sample.RawSample.get_landmarks	(		self,
			List,
			Point
	)

Получить антропометрические точки лица.

Только для фронтальных образцов. Потокобезопасный.

Возвращает

Вектор позиций антропометрических точек на оригинальном изображении.

def face_sdk.modules.raw_sample.RawSample.get_left_eye	(		self,
			Point
	)

Получить позицию левого глаза.

Только для фронтальных образцов. Потокобезопасный.

Возвращает

Позиция левого глаза на оригинальном изображении.

def face_sdk.modules.raw_sample.RawSample.get_original_image	(		self,
			RawImage
	)

Получить оригинальное изображение.

Выбрасывается исключение, если образец не содержит оригинальное изображение (проверка через hasOriginalImage (RawSample)). Потокобезопасный.

Возвращает

Оригинальное изображение.

def face_sdk.modules.raw_sample.RawSample.get_rectangle	(		self,
			Rectangle
	)

Получить ограничивающий прямоугольник лица.

Потокобезопасный.

Возвращает

Прямоугольник, ограничивающий лицо на оригинальном изображении.

def face_sdk.modules.raw_sample.RawSample.get_right_eye	(		self,
			Point
	)

Получить позицию правого глаза.

Только для фронтальных образцов. Потокобезопасный.

Возвращает

Позиция правого глаза на оригинальном изображении.

def face_sdk.modules.raw_sample.RawSample.get_score	(		self,
			float
	)

Получить уверенность детектирования лица (для образцов, полученных с помощью поддерживаемого Capturer).

Потокобезопасный.

Возвращает

Один, если образец был получен через неподдерживаемый Capturer, иначе - число в диапазоне [0 ... 1].

def face_sdk.modules.raw_sample.RawSample.get_type	(		self,
			int
	)

Получить тип образца.

Потокобезопасный.

Возвращает

Тип образца.

def face_sdk.modules.raw_sample.RawSample.has_original_image	(		self,
			int
	)

Хранит ли образец оригинальное изображение, с которого он был получен (True для образцов, полученных с помощью VideoWorker с включенным параметром store_original_frame_in_raw_sample).

Потокобезопасный.

Возвращает

True, если содержит, иначе False.

def face_sdk.modules.raw_sample.RawSample.save	(		self,
			binary_stream
	)

Сохранить (сериализовать) образец.

Оригинальное изображение не сохраняется. (т.е. сохраняется только часть изображения, содержащая лицо). Формат платформонезависимый. Потокобезопасный. Десериализовать образец можно через FacerecService.load_raw_sample.

Аргументы

[out]	binary_stream	Объект потока. Поток файла (BytesIO).
[in]	format	Формат кодирования изображения.

def face_sdk.modules.raw_sample.RawSample.save_without_image	(		self,
			binary_stream
	)

Сохранить (сериализовать) всю информацию, кроме изображения.

Вы должны сохранить изображение самостоятельно для того, чтобы подать его в FacerecService.load_raw_sample_without_image для десериализации. В случае, если над изображением была выполнена трансформация, вы можете указать параметры преобразования пространства координат: (x, y) -> ( (x + space_translation_x) * space_scale, (y + space_translation_y) * space_scale ) которое будет применено к информации о позиции лица. Заметьте, что параметры одного и того же преобразования нужно передавать только один раз - либо при сериализации, либо при десериализации, иначе преобразование будет применено дважды, что неверно. Формат платформонезависимый. Потокобезопасный. Десериализовать образец можно через FacerecService.load_raw_sample_without_image.

Аргументы

[in]	binary_stream	Объект потока для сохранения "сырого" изображения. Поток файла (BytesIO).
[in]	space_translation_x	Параметр преобразования пространства координат.
[in]	space_translation_y	Параметр преобразования пространства координат.
[in]	space_scale	параметр преобразования пространства координат.

def face_sdk.modules.raw_sample.RawSample.to_context

(

self

)

преобразет RawSample в контейнер-Context.

Возвращает

контейнер-Context