JCV属性分析SDK マニュアル (Java for Android)
目次
1 概要 2
1.1 導入前準備 2
1.2 SDK説明 2
2 SDKインテグレーション 3
2.1 “AndroidManifest.xml”ファイル設定 3
2.2 SDKの導入 3
2.3 SDKの初期化 4
2.4 SDKのリリース 4
2.5 SDK初期化に関する詳細パラメータの説明 5
2.6 SDK設定 5
3 APIの説明 8
3.1 offer 8
3.2 setConfig 8
3.3 currentTrackingFace 9
3.4 facesOfPastTimeRange 9
3.5 currentTrackingBody 9
4 タイプの説明 10
4.1 TrackingFace 10
4.2 Face Attribute 10
4.3 Face 10
4.4 TrackingBody 11
4.5 BodyAttribute 11
4.5 コードテーブル 12
5 難読化コード 13
6 FAQ 14

改訂履歴

バージョン
改訂日
改訂箇所
V2.0.0
2019-12-3
First release of GE (Global Edition).
V2.0.1
2019-12-18
Delete InsightFaceAttribute.
V2.0.2
2019-12-23
Fix minor issues.

1. 概要

1.1 導入前準備

SDKパッケージ中にはSDKインテグレーション用“aar”ファイルとサンプルプログラムが含まれております、ご確認ください。

1.2 SDK説明

JCV属性分析SDKはオフライン店舗における、顧客の行動分析の提供をコンセプトに開発されたSDKです。オフライン店舗において、顧客の行動分析情報を提供することで、購買体験を最適化し、顧客へ提供する情報の精度およびパーソナルサービスの効率向上を実現します。

2. SDKインテグレーション

2.1 “AndroidManifest.xml”ファイル設定

1
<uses-permission android:name="android.permission.INTERNET"/>
2
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
3
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
4
<uses-permission android:name="android.permission.CAMERA"/>
Copied!

2.2 SDKの導入

1 SDKの“aar”ファイルを“module”下にある“libs”フォルダに入れてください。
2 導入するSDKの“module“下にある”build.gradle“を次ように変更する。
1
android {
2
...
3
repositories {
4
flatDir {
5
dirs 'libs' // 「aar」ディレクトリ
6
}
7
}
8
}
9
dependencies {
10
...
11
//insight sdk
12
implementation(name: 'ST SenseInsight Android service SDK -GE V2.0.2', ext: 'aar')
13
implementation 'com.squareup.retrofit2:retrofit:2.4.0'
14
}
Copied!

2.3 SDKの初期化

1
SDKParams params = SDKParams.builder()
2
.context(this.getApplicationContext())
3
.licensePath("dev_license.lic")// ライセンスファイルパス:「assets」または「sdcard」
4
.businessConfigPath(businessPath)
5
.build();
6
InsightSDK.init(params, new SDKInitCallback() {
7
@Override
8
public void success() {
9
Log.i("TAG", "insight sdk init success !");
10
}
11
12
@Override
13
public void failed(int code, String msg) {
14
Log.i("TAG", "insight sdk init failed : code " + code + "msg" + msg);
15
}
16
});
Copied!

2.4 SDKのリリース

1
InsightSDK.release();
Copied!

2.5 SDK初期化に関する詳細パラメータの説明

1
//オプショナルパラメータ
2
HashMap<String, String> modelsConfig = new HashMap<>();
3
modelsConfig.put(SDKModels.KEY_FACE_ALIGN,
4
"M_Align_occlusion_106_1.16.4.model");
5
modelsConfig.put(SDKModels.KEY_FACE_ATTRIBUTE,
6
"M_Attribute_Face_Advertisement_3.5.0.model");
7
modelsConfig.put(SDKModels.KEY_FACE_DETECT,
8
"MM_ObjectFlow_Face_SenseInsight_Common_BGR_1.0.1.model");
9
modelsConfig.put(SDKModels.KEY_FACE_VERIFY,
10
"M_Verify_VehicleFace_Common_2.47.0.model");
11
modelsConfig.put(SDKModels.KEY_HEAD_POSE,
12
"M_Align_CalcPose_Ann_106_2.4.0.model");
13
modelsConfig.put(SDKModels.KEY_BODY_DETECT,
14
"M_Detect_Body_Hunter_1.5.0.model");
15
modelsConfig.put(SDKModels.KEY_BODY_ALIGN,
16
"M_Detect_Body_Keypoints_5.0.17.model");
17
modelsConfig.put(SDKModels.KEY_BODY_ATTRIBUTE,
18
"M_Attribute_Body_Fir_1.1.0.model");
19
SDKModelConfig sdkModelConfig = SDKModelConfig.builder()
20
.modelDirPath("model")// 「assets」 または 「sdcard」 パス
21
.modelsConfig(modelsConfig)
22
.build();
Copied!

2.6 SDK設定

1
#
2
# SDK機能スイッチ (0の場合: 起動しない 1の場合: 起動する)
3
#
4
# 顔属性取得の有効化 (defaults:1)
5
function_switch_face_attribute=1
6
# 注視機能の有効化 (defaults: 1)
7
function_switch_face_watch = 1
8
# 顔イメージクロップ機能の有効化(defaults:1)
9
function_switch_face_image_crop=1
10
# 統計用の顔認証を用いたユーザマージ機能の有効化 (デフォルト:1)
11
function_switch_face_recognition=1
12
# 統計用の身体検出とトラキング機能の有効化 (デフォルト:0)
13
# 「function_switch_body_track」を「1」に設定した時のみ、
14
# 「function_switch_body_attribution」および
15
# 「function_switch_body_image_crop」が「1」に設定可能です。
16
function_switch_body_track=0
17
# 身体属性取得の有効化 (デフォルト:)
18
# 「function_switch_body_track」を「1」に設定した場合のみ、
19
# このアイテムは「1」に設定可能です。
20
function_switch_body_attribute=0
21
#身体イメージクロップ機能の有効化(デフォルト:0)
22
#「function_switch_body_track」を「1」に設定した場合のみ、
23
# このアイテムは「1」に設定可能です。
24
function_switch_body_image_crop=0
25
#
26
# 注視機能設定
27
# 「function_switch_face_watch」を「1」に設定した場合、
28
# SDK顔注視設定中のアイテムは有効である。
29
# function_switch_face_watch is set to 1.
30
#
31
# 水平方向の注視範囲の注視におけるネガティブ値
32
key_parameter_negative_yaw=-20
33
# 水平方向の注視範囲の注視におけるポジティブ値
34
key_parameter_positive_yaw=20
35
# 垂直方向の注視範囲におけるネガティブ値
36
key_parameter_negative_pitch=-10
37
# 垂直方向の注視範囲におけるポジティブ値
38
key_parameter_positive_pitch=30
39
#
40
# SDK key パラメータ設定
41
#
42
#0: 顔属性を一定期間毎の呼び出しを実行しない
43
#1: 顔属性を一定期間毎の呼び出しを実行する (デフォルト: 0)
44
#このパラメータが「1」に設定された場合、
45
# 「key_parameter_face_attribution_times」が無効になり、
46
# 「key_parameter_face_attribution_period」が有効になる。
47
key_parameter_timed_face_attribute=0
48
# 顔属性を呼び出す間隔時間。単位:ms(デフォルト:1000)、有効範囲:[1000, 60000]
49
key_parameter_face_attribute_period=1000
50
#顔クオリティスコアの最小値。
51
#1ユーザの顔トラックのおける顔イメージクオリティがこの値以上である場合
52
#のみ、顔属性または顔照合が呼び出されるか、イメージがトリミングされる。(デフォルト:0.3)有効範囲:[0.1, 0.5]
53
key_parameter_min_face_quality=0.3
54
#顔クオリティスコアの増加値。1ユーザの顔トラックにおいて、前のイメージクオリティスコアより一定量以上
55
#増加したクオリティスコアを持つ新しいイメージに対し、再度、顔属性/顔照合が呼び出されるか
56
#顔イメージがトリミングされる(デフォルト:0.2)有効範囲:[0.1, 0.5]
57
key_parameter_incremental_face_quality=0.2
58
# 身体クオリティスコアの最小値。1つの身体トラックのおける身体イメージクオリティがこの値以上である
59
# 場合のみ、身体属性が呼び出される、またはイメージがトリミングされる。(デフォルト:0.3)有効範囲:[0.1, 0.5]
60
key_parameter_min_body_quality=0.3
61
# 身体クオリティスコアの増加値。1ユーザの身体トラックにおいて、前のイメージクオリティスコアより一定量
62
# 以上増加したクオリティスコアを持つ新しいイメージに対し、再度、身体属性/身体照合が呼び出されるか
63
# 顔イメージがトリミングされる(デフォルト:0.2)有効範囲:[0.1, 0.5]
64
key_parameter_incremental_body_quality=0.2
65
# 同一人物の複数顔を統計のためにマージする時間の範囲。単位:min、有効範囲:[1 , 86400]
66
key_parameter_face_merge_time_range=5
67
# 顔認証類似スコアの閾値、有効範囲:[0, 1]
68
key_parameter_face_similarity_threshold=0.6
Copied!

3. APIの説明

3.1 offer

1
InsightSDK.service().offer();
Copied!

3.2 setConfig

1
// SKDを初期化した後、操作途中に、初期化せずパラメータのアップデートを行えます。
2
3
// カメラプレビューの幅と高さの設定。
4
5
InsightSDK.config().setPreviewSize(cameraPreviewWidth, cameraPreviewHeight);
6
7
//デバッグモードの設定。デバッグモードでは、より詳細なログが利用可能
8
9
InsightSDK.config().setDebugMode(true);
10
11
// SDK Keyパラメータの設定。
12
13
SDKConfig build = SDKConfig.builder()
14
.timedFaceAttribute(1)// 顔属性を一定期間毎の呼び出しを実行する
15
.faceAttributionPeriod(1000)// 顔属性呼び出すの時間間隔。
16
.faceMergeTimeRange(5) // 単位: min //1ユーザに対して、複数顔トラックした際に統計情報作成の際にマージする時間範囲
17
.incrementalFaceQuality(0.2f)// 1ユーザの顔トラックにおいて、前のイメージクオリティスコアより
18
//一定量以上増加したクオリティスコアを持つ新しいイメージに対し、再度、顔属性/顔照合が
19
//呼び出されるか顔イメージがトリミングされる
20
.incrementalBodyQuality(0.2f)// 1ユーザの身体トラックにおいて、前のイメージクオリティスコアより一定量以上増加したクオリティスコアを持つ新しいイメージに対し、再度、身体属性/身体照合が呼び出されるか顔イメージがトリミングされる(デフォルト:0.2)
21
.minBodyQuality(0.3f)// 1つの身体トラックのおける身体イメージクオリティがこの値以上である
22
//場合のみ、身体属性が呼び出される、またはイメージがトリミングされる。
23
.minFaceQuality(0.3f)// 1つの身体トラックのおける身体イメージクオリティがこの値以上である
24
//場合のみ、身体属性が呼び出される、またはイメージがトリミングされる。
25
.build();
26
27
InsightSDK.config().setSDKKeyParameterConfig(build);
28
InsightSDK.config().enableFaceAttribute(true);
29
InsightSDK.config().enableFaceWatch(true);
30
InsightSDK.config().enableFaceImageCrop(true);
31
InsightSDK.config().enableFaceRecognition(true);
32
InsightSDK.config().enableBodyTrack(true);
33
InsightSDK.config().enableBodyAttribute(true);
34
InsightSDK.config().enableBodyImageCrop(true);
Copied!

3.3 currentTrackingFace

1
//現在の顔情報を取得。
2
List<TrackingFace> trackingFaces =InsightSDK.service().currentTrackingFace();
Copied!

3.4 facesOfPastTimeRange

1
// 過去一定の時間範囲内の顔情報(ユーザマージ済み)を取得。
2
// The following forms are equivalent for calling.
3
4
long now = System.currentTimeMillis();
5
List<Face> faces = InsightSDK.service().facesOfPastTimeRange(now - 3000, now);
6
7
List<Face> faces = InsightSDK.service().facesOfPastTimeRange(3000);
Copied!

3.5 currentTrackingBody

1
//現在の身体情報を取得
2
List<TrackingBody> trackingBodies = InsightSDK.service().currentTrackingBody();
Copied!

4. タイプの説明

4.1 TrackingFace

フィールド名
フィールド種類
フィールド説明
trackingFaceId
int
Face track id(ユーザマージ前)
faceId
int
Face id(ユーザマージ後)
enter
long
チェックイン時刻
leave
long
チェックアウト時刻
gender
String
性別(M:男性;F:女性)
age
int
年齢
quality
float
顔認識クオリティスコア(0-1)
faceRect
Rect
顔検知時のフレーム
watchTime
long
注視時間(ms)
expression
String
表情
glasses
int
メガネ(0:利用せず;1:メガネ;2:サングラス;-1:不明)
mask
int
マスク(0:no;1:yes;-1:不明)
smileScore
int
笑顔スコア
charmScore
int
魅力スコア
faceFeature
byte[]
顔の特徴量
faceImage
StImage
クロップされた顔画像
faceImageQuality
float
クロップされた顔画像のクオリティスコア
beard
int
ひげ(0:no;1:yes;-1:不明)
associateBodyTrackID
int
関連付けられたbody id

4.2 Face Attribute

フィールド名
フィールド説明
属性タグ
属性説明
expression
顔表情
others
その他
happy
喜ぶ
calm
穏やか

4.3 Face

フィールド名
フィールド種類
フィールド説明
faceId
int
face id(顔のユニークID)
gender
String
性別(M:男性;F:女性)
age
int
年齢
faceImage
StImage
クロップされた顔画像
watchTime
long
注視時間(ms)
otherEmotionTime
long
「喜び」と「穏やか」以外が検知された時間(ms)
calmEmotionTime
long
「穏やか」が検知された時間
happyEmotionTime
long
「喜び」が検知された時間
glasses
int
メガネ(0:利用せず;1:メガネ;2:サングラス;-1:不明)
mask
int
マスク(0:マスク着用せず;1:マスク着用)
charmScore
int
魅力スコア
facefeature
byte[]
顔の特徴量
faceImageQuality
float
クロップされた顔画像のクオリティスコア
beard
int
ひげ(0:no;1:yes;-1:不明)

4.4 TrackingBody

フィールド名
フィールド種類
フィールド説明
trackId
int
身体トラックId
bodyQuality
float
身体クオリティ(0-1)
bodyRect
StRect
身体検知時のフレーム
associatedFaceTrackID
int
関連付けられたface id
(-1:マッチする顔がない)
attribute
BodyAttribute
身体属性情報
age
String
年齢(成人、高齢者、児童)
gender
String
性別(M:男性;F:女性)
bodyImage
StImage
クロップされた身体画像

4.5 BodyAttribute

フィールド名
フィールド種類
フィールド説明
UpperClothing
String
上着の種類(半袖、長袖)
LowerClothing
String
パンツの種類(長ズボン、短パン、スカート)
UpperMode
String
上着の模様(単色、ストライプ、Design、Joint、Lattic)
LowerMode
String
パンツの模様(単色、ストライプ、Design、Joint、Lattic)
UpperType
String
上着のスタイル(ロングコート、ジャケット、Tシャツ、スポーツウェア、ダウン、シャツ、ドレス、スーツ)
UpperColor
String
上着の色(黒色、白色、灰色、赤色、黄色、青色、緑色、紫色)
LowerColor
String
パンツの色(黒色、白色、灰色、赤色、黄色、青色、緑色、紫色)
Age
String
年齢層(成人、高齢者、児童)
gender
String
性別(M:男性;F:女性)

4.5 コードテーブル

コード
説明
100
CODE_OK
101
reinit sdk
103
running error
104
params illegal
201
algorithm no detect face
202
algorithm sdk release
203
algorithm no feature
204
algorithm unknown img format
205
algorithm img decode failed
206
algorithm img size illegal
207
algorithm params illegal
208
algorithm pls_enable face recognition
210
algorithm st exception

5. 難読化コード

プロジェクトの難読化設定:次のように“proguard-rules.pro”内にコードを追加してください:
1
######insight sdk########
2
-keep class com.sensetime.** {*;}
3
4
########retrofit#######
5
#retrofit2 Obfuscation
6
-keepattributes Signature, InnerClasses, EnclosingMethod
7
-keepattributes RuntimeVisibleAnnotations, RuntimeVisibleParameterAnnotations
8
-keepclassmembers,allowshrinking,allowobfuscation interface * {
9
@retrofit2.http.* <methods>;
10
}
11
-dontwarn org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement
12
-if interface * { @retrofit2.http.* <methods>; }
13
-keep,allowobfuscation interface <1>
14
15
# OkHttp3
16
-dontwarn javax.annotation.**
17
-keepnames class okhttp3.internal.publicsuffix.PublicSuffixDatabase
18
-dontwarn org.codehaus.mojo.animal_sniffer.*
19
-dontwarn okhttp3.internal.platform.ConscryptPlatform
20
21
# Okio
22
-dontwarn org.codehaus.mojo.animal_sniffer.*
23
24
########Insight-Gson##########
25
-keepattributes Signature
26
-keepattributes *Annotation*
27
-keep class sun.misc.Unsafe { *; }
28
-keep class com.sensetime.insight.gson.** {*;}
Copied!

6. FAQ

  1. 1.
    なぜAPI”currentTrackingFace“実行時に、顔データを取得できないのでしょうか?
1
A: データの取得が失敗した場合、SDKが正常に初期化したかをチェックしてください。
2
3
その後、デバイスとの接続モジュールをチェックし、最後に、カメラが正しい向きであることをチェックする。
Copied!
  1. 1.
    インタ-フェース”currentTrackingFace”を同時に複数のスレッドに呼びだすことが可能でしょうか?
1
A: こちらのインターフェースはシングルスレッドのみの対応となります。
Copied!
  1. 1.
    リリースした後のSDKの再初期化は可能でしょうか?
1
A: 再初期化は実行可能です。
Copied!
  1. 1.
    インターフェース“currentTrackingface”から取得した顔属性は空である場合があります。
1
A: 属性を抽出する際、SDKは認識した顔のクオリティを基づいて判断します。
2
3
クオリティを満たさない場合は、属性を取得できない場合があります。
4
5
高いクオリティスコアの顔情報を取得できる場合のみ、属性を取得することが出来ます。
Copied!
  1. 1.
    インターフェース“currentTrackingFace”を呼び出頻度およびシチュエーションについて教えて下さい。
1
A: 以下の例がインターフェースを呼び出し頻度となります。 
2
3
- 1. チルドスレッドは30msごとに呼び出し、取得データはスクリーンに表示させる。
4
- 2. カルセールしている間、1秒ごとに顔データを取得する際に呼び出す。
5
- 3. 1つイベント(例えば、1つの購入イベント)が発生した時、カレントスクリーン前の顔データを取得するために呼び出す。
Copied!
EOF
最終更新 1mo ago