[Unity]Unityを使って画像認識してみた

## 初めに
今回、株式会社GENEROSITY様でインターンシップをさせていただき、その中で行った開発について記事を書いていきます！
他にもいくつか記事を書いたので、他の記事も見ていただけると嬉しいです！
## 本記事を読む前に
この記事では、Unityのインストールなどについては記述しません。インストールが終わっている前提で進めていきます。インストールについては下記のリンクから行ってください。

https://unity.com/ja/download

## 本記事で出来ること
Unityでの画像認識を行うことができる

![barracuda15.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2517131/199db0f7-9ac9-3f6f-2f7d-0e0512228cfe.png)

# 目次

[1.事前準備](#事前準備)
[2.Barracudaとは](#barracudaとは)
[3.開発](#開発)
　[1.Barracudaのインポート](#barracudaのインポート)
　[2.Modelのインポート](#modelのインポート)
　[3.ラベルのインポート](#ラベルのインポート)
　[4.Sceneの準備](#sceneの準備)
　[5.プログラムの記述](#プログラムの記述)
[4.結果](#結果)
[5.まとめ](#まとめ)
[6.参考資料](#参考資料)

## 事前準備
Unityのインストールを行い、プロジェクトを作成しておいてください。
今回は下記のような環境で実行しました

・Unity 2021.3.29.f1
・URP 12.1.12
・Windows 11

(他のUnityバージョン、レンダリングパイプラインは未確認です。)

## Barracudaとは
Unityの公式パッケージとして提供されているニューラルネットワーク推論ライブラリであり、顔認識や画像認識を行えるライブラリです。

https://blog.unity.com/ja/engine-platform/real-time-style-transfer-in-unity-using-deep-neural-networks

https://learning.unity3d.jp/7557/

## 開発
### Barracudaのインポート
プロジェクトを開くことができたら、Window → Package Managerを開きます。
左上のプラスボタンを押し、Add by package name...を押します。

![barracuda01.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2517131/9794e5be-2043-b058-8330-9bdd319ff5f3.png)

すると、このような画面になります。
![barracuda02.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2517131/54b7c80a-cc24-f1d7-b885-972d2fc7a005.png)

Nameの部分に下記の文字列を入力してください。
もしバージョンを指定したい場合は、Versionの部分に該当バージョンを入力してください。特にない場合は空欄で大丈夫です。
```
com.unity.barracuda
```
Addを押すと、インポートされます。
Package Manager内にBarracudaがあればインポートができています。
### Modelのインポート
次に推論用のモデルのインポートを行います。
今回はこちらのGithubからMobileNet v2-1.0をお借りします

https://github.com/onnx/models

![barracuda03.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2517131/56de4d13-15ca-acd1-dea4-da792e842b60.png)

モデルをダウンロードします。

![barracuda04.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2517131/2df4f11f-02b9-5d5d-211c-6a9d7eed48b1.png)

ダウンロードができたらUnityにインポートします。Assetsフォルダ内に配置してください。

![barracuda05.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2517131/ca47bd84-5e5f-8ffd-6dee-9a4b8add307d.png)

### ラベルのインポート
画像認識をした際に、何を認識したのかのラベルが必要なため、Label.txtを作成し、Unityにインポートしておいてください。
<details><summary>Label.txt</summary>

```
tench
goldfish
great white shark
tiger shark
hammerhead
electric ray
stingray
cock
Hen
ostrich
brambling
goldfinch
house finch
junco
indigo bunting
robin
bulbul
jay
magpie
chickadee
water ouzel
kite
bald eagle
vulture
great grey owl
European fire salamander
common newt
eft
spotted salamander
axolotl
bullfrog
tree frog
Tailed frog
loggerhead
leatherback turtle
mud turtle
terrapin
box turtle
banded gecko
common iguana
American chameleon
whiptail
agama
frilled lizard
alligator lizard
Gila monster
green lizard
African chameleon
Komodo dragon
African crocodile
American alligator
triceratops
thunder snake
ringneck snake
hognose snake
green snake
king snake
garter snake
water snake
vine snake
night snake
boa constrictor
rock python
Indian cobra
green mamba
sea snake
horned viper
diamondback
sidewinder
trilobite
harvestman
scorpion
black and gold garden spider
barn spider
garden spider
black widow
tarantula
wolf spider
tick
centipede
black grouse
ptarmigan
ruffed grouse
prairie chicken
peacock
quail
partridge
African grey
macaw
sulphur-crested cockatoo
lorikeet
coucal
bee eater
hornbill
hummingbird
jacamar
toucan
drake
red-breasted merganser
Goose
black swan
tusker
echidna
platypus
wallaby
koala
wombat
jellyfish
sea anemone
brain coral
flatworm
nematode
conch
snail
slug
sea slug
chiton
chambered nautilus
Dungeness crab
rock crab
fiddler crab
king crab
American lobster
spiny lobster
crayfish
hermit crab
isopod
white stork
black stork
spoonbill
flamingo
little blue heron
American egret
bittern
crane
limpkin
European gallinule
American coot
bustard
ruddy turnstone
red-backed sandpiper
redshank
dowitcher
oystercatcher
pelican
king penguin
albatross
grey whale
killer whale
dugong
sea lion
Chihuahua
Japanese spaniel
Maltese dog
Pekinese
Shih-Tzu
Blenheim spaniel
papillon
toy terrier
Rhodesian ridgeback
Afghan hound
basset
beagle
bloodhound
bluetick
black-and-tan coonhound
Walker hound
English foxhound
redbone
borzoi
Irish wolfhound
Italian greyhound
whippet
Ibizan hound
Norwegian elkhound
otterhound
Saluki
Scottish deerhound
Weimaraner
Staffordshire bullterrier
American Staffordshire terrier
Bedlington terrier
Border terrier
Kerry blue terrier
Irish terrier
Norfolk terrier
Norwich terrier
Yorkshire terrier
wire-haired fox terrier
Lakeland terrier
Sealyham terrier
Airedale
cairn
Australian terrier
Dandie Dinmont
Boston bull
miniature schnauzer
giant schnauzer
standard schnauzer
Scotch terrier
Tibetan terrier
silky terrier
soft-coated wheaten terrier
West Highland white terrier
Lhasa
flat-coated retriever
curly-coated retriever
golden retriever
Labrador retriever
Chesapeake Bay retriever
German short-haired pointer
vizsla
English setter
Irish setter
Gordon setter
Brittany spaniel
clumber
English springer
Welsh springer spaniel
cocker spaniel
Sussex spaniel
Irish water spaniel
kuvasz
schipperke
groenendael
malinois
briard
kelpie
komondor
Old English sheepdog
Shetland sheepdog
collie
Border collie
Bouvier des Flandres
Rottweiler
German shepherd
Doberman
miniature pinscher
Greater Swiss Mountain dog
Bernese mountain dog
Appenzeller
EntleBucher
boxer
bull mastiff
Tibetan mastiff
French bulldog
Great Dane
Saint Bernard
Eskimo dog
malamute
Siberian husky
dalmatian
affenpinscher
basenji
pug
Leonberg
Newfoundland
Great Pyrenees
Samoyed
Pomeranian
chow
keeshond
Brabancon griffon
Pembroke
Cardigan
toy poodle
miniature poodle
standard poodle
Mexican hairless
timber wolf
white wolf
red wolf
coyote
dingo
dhole
African hunting dog
hyena
red fox
kit fox
Arctic fox
grey fox
Tabby
tiger cat
Persian cat
Siamese cat
Egyptian cat
cougar
lynx
leopard
snow leopard
jaguar
lion
tiger
cheetah
brown bear
American black bear
ice bear
sloth bear
mongoose
meerkat
tiger beetle
ladybug
ground beetle
long-horned beetle
leaf beetle
dung beetle
rhinoceros beetle
weevil
fly
Bee
ant
grasshopper
cricket
walking stick
cockroach
mantis
cicada
leafhopper
lacewing
dragonfly
damselfly
admiral
ringlet
monarch
cabbage butterfly
sulphur butterfly
lycaenid
starfish
sea urchin
sea cucumber
wood rabbit
hare
Angora
Hamster
porcupine
fox squirrel
marmot
beaver
guinea pig
sorrel
zebra
hog
wild boar
warthog
hippopotamus
ox
water buffalo
bison
ram
bighorn
ibex
hartebeest
impala
gazelle
Arabian camel
llama
weasel
mink
polecat
black-footed ferret
otter
skunk
badger
armadillo
three-toed sloth
orangutan
gorilla
chimpanzee
gibbon
siamang
guenon
patas
baboon
macaque
langur
colobus
proboscis monkey
marmoset
capuchin
howler monkey
titi
spider monkey
squirrel monkey
Madagascar cat
indri
Indian elephant
African elephant
lesser panda
giant panda
barracouta
eel
coho
rock beauty
anemone fish
sturgeon
gar
lionfish
puffer
abacus
abaya
academic gown
accordion
acoustic guitar
aircraft carrier
airliner
airship
altar
ambulance
amphibian
analog clock
apiary
apron
ashcan
assault rifle
backpack
bakery
balance beam
balloon
ballpoint
Band Aid
banjo
bannister
barbell
barber chair
barbershop
barn
barometer
barrel
barrow
baseball
basketball
bassinet
bassoon
bathing cap
bath towel
bathtub
beach wagon
beacon
beaker
bearskin
beer bottle
beer glass
bell cote
bib
bicycle-built-for-two
bikini
binder
binoculars
birdhouse
boathouse
bobsled
bolo tie
bonnet
bookcase
bookshop
bottlecap
bow
bow tie
brass
brassiere
breakwater
breastplate
broom
bucket
buckle
bulletproof vest
bullet train
butcher shop
cab
caldron
candle
cannon
canoe
can opener
cardigan
car mirror
carousel
carpenter's kit
carton
car wheel
cash machine
cassette
cassette player
castle
catamaran
CD player
cello
cellular telephone
chain
chainlink fence
chain mail
chain saw
chest
chiffonier
chime
china cabinet
Christmas stocking
church
cinema
cleaver
cliff dwelling
cloak
clog
cocktail shaker
Coffee mug
coffeepot
coil
combination lock
computer keyboard
confectionery
container ship
convertible
corkscrew
cornet
cowboy boot
cowboy hat
cradle
crane
crash helmet
crate
crib
Crock Pot
croquet ball
crutch
cuirass
dam
desk
desktop computer
dial telephone
diaper
digital clock
digital watch
dining table
dishrag
dishwasher
disk brake
dock
dogsled
dome
doormat
drilling platform
drum
drumstick
dumbbell
Dutch oven
electric fan
electric guitar
electric locomotive
entertainment center
envelope
espresso maker
face powder
feather boa
file
fireboat
fire engine
fire screen
flagpole
flute
folding chair
football helmet
forklift
fountain
fountain pen
four-poster
freight car
French horn
frying pan
fur coat
garbage truck
gasmask
gas pump
goblet
go-kart
golf ball
golfcart
gondola
gong
gown
grand piano
greenhouse
grille
grocery store
guillotine
hair slide
hair spray
half track
hammer
hamper
hand blower
hand-held computer
handkerchief
hard disc
harmonica
harp
harvester
hatchet
holster
home theater
honeycomb
hook
hoopskirt
horizontal bar
horse cart
hourglass
iPod
iron
jack-o'-lantern
jean
jeep
jersey
jigsaw puzzle
jinrikisha
joystick
kimono
knee pad
knot
lab coat
ladle
lampshade
laptop
lawn mower
lens cap
letter opener
library
lifeboat
lighter
limousine
liner
lipstick
Loafer
lotion
loudspeaker
loupe
lumbermill
magnetic compass
mailbag
mailbox
maillot
maillot
manhole cover
maraca
marimba
mask
matchstick
maypole
maze
measuring cup
medicine chest
megalith
microphone
microwave
military uniform
milk can
minibus
miniskirt
minivan
missile
mitten
mixing bowl
mobile home
Model T
modem
monastery
monitor
moped
mortar
mortarboard
mosque
mosquito net
motor scooter
mountain bike
mountain tent
mouse
mousetrap
moving van
muzzle
nail
neck brace
necklace
nipple
notebook
obelisk
oboe
ocarina
odometer
oil filter
organ
oscilloscope
overskirt
oxcart
oxygen mask
packet
paddle
paddlewheel
padlock
paintbrush
pajama
palace
panpipe
paper towel
parachute
parallel bars
park bench
parking meter
passenger car
patio
pay-phone
pedestal
pencil box
pencil sharpener
perfume
Petri dish
photocopier
pick
pickelhaube
picket fence
pickup
pier
piggy bank
pill bottle
pillow
ping-pong ball
pinwheel
pirate
pitcher
plane
planetarium
plastic bag
plate rack
plow
plunger
Polaroid camera
pole
police van
poncho
pool table
pop bottle
pot
potter's wheel
power drill
prayer rug
printer
prison
projectile
projector
puck
punching bag
purse
quill
quilt
racer
racket
Radiator
radio
radio telescope
rain barrel
recreational vehicle
reel
reflex camera
refrigerator
remote control
restaurant
revolver
rifle
rocking chair
rotisserie
rubber eraser
rugby ball
rule
running shoe
safe
safety pin
saltshaker
sandal
sarong
sax
scabbard
scale
school bus
schooner
scoreboard
screen
screw
screwdriver
seat belt
sewing machine
shield
shoe shop
shoji
shopping basket
shopping cart
shovel
shower cap
shower curtain
ski
ski mask
sleeping bag
slide rule
sliding door
slot
snorkel
snowmobile
snowplow
soap dispenser
soccer ball
sock
solar dish
sombrero
soup bowl
space bar
space heater
space shuttle
spatula
speedboat
spider web
spindle
sports car
spotlight
stage
steam locomotive
steel arch bridge
steel drum
stethoscope
stole
stone wall
stopwatch
stove
strainer
streetcar
stretcher
studio couch
stupa
submarine
suit
sundial
sunglass
sunglasses
sunscreen
suspension bridge
swab
sweatshirt
swimming trunks
swing
switch
syringe
table lamp
tank
tape player
teapot
teddy
television
tennis ball
thatch
theater curtain
thimble
thresher
throne
tile roof
toaster
tobacco shop
toilet seat
torch
totem pole
tow truck
toyshop
tractor
trailer truck
tray
trench coat
tricycle
trimaran
tripod
triumphal arch
trolleybus
trombone
tub
turnstile
typewriter keyboard
umbrella
unicycle
upright
vacuum
vase
vault
velvet
vending machine
vestment
viaduct
violin
volleyball
waffle iron
wall clock
wallet
wardrobe
warplane
washbasin
washer
water bottle
water jug
water tower
whiskey jug
whistle
wig
window screen
window shade
Windsor tie
wine bottle
wing
wok
wooden spoon
wool
worm fence
wreck
yawl
yurt
web site
comic book
crossword puzzle
street sign
traffic light
book jacket
menu
plate
guacamole
consomme
hot pot
trifle
ice cream
ice lolly
French loaf
bagel
pretzel
cheeseburger
hotdog
mashed potato
head cabbage
broccoli
cauliflower
zucchini
spaghetti squash
acorn squash
butternut squash
cucumber
artichoke
bell pepper
cardoon
mushroom
Granny Smith
strawberry
orange
lemon
fig
pineapple
banana
jackfruit
custard apple
pomegranate
hay
carbonara
chocolate sauce
dough
meat loaf
pizza
potpie
burrito
red wine
espresso
cup
eggnog
alp
bubble
cliff
coral reef
geyser
lakeside
promontory
sandbar
seashore
valley
volcano
ballplayer
groom
scuba diver
rapeseed
daisy
yellow lady's slipper
corn
acorn
hip
buckeye
coral fungus
agaric
gyromitra
stinkhorn
earthstar
hen-of-the-woods
bolete
ear
toilet tissue
```
</details>
もしくは、下記のGithubよりダウンロードしてください。こちらはUnity公式から出ているものです。

https://github.com/Unity-Technologies/barracuda-starter-kit/blob/main/UnityProject/Assets/01-StaticImageRecognition-MobileNetV2/Models/class_desc.txt

### Sceneの準備
プログラムを記述する前に、Sceneの準備をします。
まず、Cameraをもう一つ作成します。この作成したCameraの画像を画像認識のプログラムに渡します。
![barracuda07.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2517131/2d92e710-1aac-05c8-aa7c-9b0fa8369584.png)

この作成したCameraのTransformを下記の画像のようにします。このときMain CameraのTransformも同じ値にしておいてください。

:::note info
Main Cameraも同じTransformにしなくても動作に影響はありません。実行したときに見やすくするために変更しているだけです。
:::
![barracuda08.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2517131/cf3c74e5-fada-090b-e96a-4823240ee247.png)

続いて、Assetsフォルダ内にRender Textureを作成します。

![barracuda09.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2517131/f1d85c21-b6f8-ce2b-b8ad-5507c0aea5b3.png)
作成したRender Textureを先ほど作成したCameraにアタッチします。

![barracuda10.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2517131/d8e5d724-ff07-929f-7b9d-f65219cf25bb.png)

最後にScene上にQuadオブジェクトを配置します。もし、配置した時点でTransformが原点ではなかった場合には、原点にしておいてください。
![barracuda11.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2517131/047bf7fe-9590-6b2d-1522-6e5cff277215.png)

このQuadオブジェクトにLabelとしてある物体の画像ファイルをアタッチします。
今回、私は障子の画像を付けました。
![barracuda12.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2517131/5e316b80-63be-aa1f-5a96-caed0e9d1b8b.png)


### プログラムの記述
ライブラリとモデルのインポート、Sceneの準備ができたので、画像認識するためのプログラムを記述していきます。

``` Barracuda.cs
using UnityEngine;
using Unity.Barracuda;

public class BarracudaDemo : MonoBehaviour
{
    [SerializeField] private NNModel modelAsset;            //インポートしたモデル
    [SerializeField] private RenderTexture _inputTexture;   //カメラからの画像
    [SerializeField] private TextAsset labelsAsset;         //ラベルが書かれているテキストファイル
    private Model _runtimeModel;
    private IWorker _worker;
    private string[] labels;

    private void Start()
    {
        //モデルのロード
        _runtimeModel = ModelLoader.Load(modelAsset);
        _worker = WorkerFactory.CreateWorker(WorkerFactory.Type.Compute, _runtimeModel);

        //ラベルを単語ごとに配列に代入
        labels = labelsAsset.text.Split('\n');
    }

    private void Update()
    {
        //カメラからの画像をモデルに渡している
        Tensor input = new Tensor(_inputTexture);
        Inference(input);

        //処理が終わった瞬間に破棄
        //TensorおよびWorkerは終了した時点で破棄する必要がある
        input.Dispose(); 
    }

    private void Inference(Tensor tensorInput)
    {
        //画像認識が行われる
        _worker.Execute(tensorInput);
        Tensor output = _worker.PeekOutput();

        var outputArray = output.ToReadOnlyArray();

        int maxIndex = 0;
        float max = 0;

        for (int i = 0; i < outputArray.Length; i++)
        {
            if (max < outputArray[i])
            {
                max = outputArray[i];
                maxIndex = i;
            }
        }

        //検出したものをログに出す。
        Debug.Log(labels[maxIndex]);

        output.Dispose();
    }

    private void OnDestroy()
    {
        //終了時に破棄
        _worker.Dispose();
    }
}
```

プログラムが記述できたら、適当なオブジェクトにAdd Componentします。
Emptyで作成したオブジェクトにAdd Componentしましたが、どのオブジェクトにAdd Componentしても大丈夫です。

![barracuda06.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2517131/33d1b758-2229-44b4-db7e-20f46077fe0f.png)

Noneの部分にそれぞれ
・インポートしたモデル
・Render Texture
・ラベルのテキストファイル
をアタッチしてください。

![barracuda13.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2517131/ab1c3dfa-3614-cde0-33ce-2d5b1407b256.png)

この時点で実行してみると以下のようなエラーが発生すると思います。
![barracuda14.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2517131/04518d33-6a0b-4e39-0ce7-c1c853058a01.png)

このエラーは以下のような理由で発生します。
>The assertion failure points that the script was expecting to receive three components, but it receives four:
"AssertionException: Assertion failure. Values are not equal.
Expected: 3 == 4"
>>アサーションの失敗は、スクリプトが 3 つのコンポーネントを受け取ることを予期していたのに、次の 4 つのコンポーネントを受け取ったことを示しています:
「AssertionException: アサーション失敗。値が等しくない。期待値: 3 == 4」

https://github.com/digital-standard/ThreeDPoseUnityBarracuda/issues/15

先ほど記述したプログラムを下記のように修正してください。
```diff_c_sharp
- Tensor input = new Tensor(_inputTexture);
+ Tensor input = new Tensor(_inputTexture,3);
```

## 結果
これで実行をするとログに認識されたLabelが出力され画像認識ができると思います。

![barracuda15.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2517131/199db0f7-9ac9-3f6f-2f7d-0e0512228cfe.png)

想定したLabelと違うものが出る場合もあるかもしれませんが、モデルの精度だったり、画像によっても認識精度が変わるので、変えたりして試してみてください。

## まとめ
今回、画像認識を行おうとしてUnityで行うためのライブラリを探していました。
その際に、Barracudaを見つけて、簡単な実装で画像認識ができました。他にもいろいろなモデルがあるのでぜひ試してみてください！

## 参考資料

https://redhologerbera.hatenablog.com/entry/2021/07/27/203503

https://qiita.com/highno_RQ/items/478e1145f0eb868c0f2e

https://github.com/Unity-Technologies/barracuda-release/blob/release/3.0.1/Documentation~/Installing.md