iOS の ML Kit でデジタルインクを認識する

ML Kit のデジタル インク認識機能を使用すると、デジタル サーフェスに書き込まれた数百の言語で手書き文字を認識し、スケッチを分類できます。

始める前に

  1. Podfile に次の ML Kit ライブラリを含めます。

    pod 'GoogleMLKit/DigitalInkRecognition', '3.2.0'
    
    
  2. プロジェクトの Pod をインストールまたは更新した後に、.xcworkspace を使用して Xcode プロジェクトを開きます。ML Kit は、Xcode バージョン 13.2.1 以降でサポートされています。

これで、Ink オブジェクト内のテキストを認識する準備ができました。

Ink オブジェクトをビルドする

Ink オブジェクトをビルドする主な方法は、タッチ スクリーンに描画することです。iOS では、UIImageView と、ストローク イベント ハンドラを併用して、画面にストロークを描画したり、ストロークを保存したり、Ink オブジェクトのビルド先として使用したりできます。この一般的なパターンを次のコード スニペットに示します。タップイベント処理、画面描画、ストロークデータ管理のそれぞれの分離例について詳しくは、クイックスタート アプリをご覧ください。

Swift

@IBOutlet weak var mainImageView: UIImageView!
var kMillisecondsPerTimeInterval = 1000.0
var lastPoint = CGPoint.zero
private var strokes: [Stroke] = []
private var points: [StrokePoint] = []

func drawLine(from fromPoint: CGPoint, to toPoint: CGPoint) {
  UIGraphicsBeginImageContext(view.frame.size)
  guard let context = UIGraphicsGetCurrentContext() else {
    return
  }
  mainImageView.image?.draw(in: view.bounds)
  context.move(to: fromPoint)
  context.addLine(to: toPoint)
  context.setLineCap(.round)
  context.setBlendMode(.normal)
  context.setLineWidth(10.0)
  context.setStrokeColor(UIColor.white.cgColor)
  context.strokePath()
  mainImageView.image = UIGraphicsGetImageFromCurrentImageContext()
  mainImageView.alpha = 1.0
  UIGraphicsEndImageContext()
}

override func touchesBegan(_ touches: Set, with event: UIEvent?) {
  guard let touch = touches.first else {
    return
  }
  lastPoint = touch.location(in: mainImageView)
  let t = touch.timestamp
  points = [StrokePoint.init(x: Float(lastPoint.x),
                             y: Float(lastPoint.y),
                             t: Int(t * kMillisecondsPerTimeInterval))]
  drawLine(from:lastPoint, to:lastPoint)
}

override func touchesMoved(_ touches: Set, with event: UIEvent?) {
  guard let touch = touches.first else {
    return
  }
  let currentPoint = touch.location(in: mainImageView)
  let t = touch.timestamp
  points.append(StrokePoint.init(x: Float(currentPoint.x),
                                 y: Float(currentPoint.y),
                                 t: Int(t * kMillisecondsPerTimeInterval)))
  drawLine(from: lastPoint, to: currentPoint)
  lastPoint = currentPoint
}

override func touchesEnded(_ touches: Set, with event: UIEvent?) {
  guard let touch = touches.first else {
    return
  }
  let currentPoint = touch.location(in: mainImageView)
  let t = touch.timestamp
  points.append(StrokePoint.init(x: Float(currentPoint.x),
                                 y: Float(currentPoint.y),
                                 t: Int(t * kMillisecondsPerTimeInterval)))
  drawLine(from: lastPoint, to: currentPoint)
  lastPoint = currentPoint
  strokes.append(Stroke.init(points: points))
  self.points = []
  doRecognition()
}

Objective-C

// Interface
@property (weak, nonatomic) IBOutlet UIImageView *mainImageView;
@property(nonatomic) CGPoint lastPoint;
@property(nonatomic) NSMutableArray *strokes;
@property(nonatomic) NSMutableArray *points;

// Implementations
static const double kMillisecondsPerTimeInterval = 1000.0;

- (void)drawLineFrom:(CGPoint)fromPoint to:(CGPoint)toPoint {
  UIGraphicsBeginImageContext(self.mainImageView.frame.size);
  [self.mainImageView.image drawInRect:CGRectMake(0, 0, self.mainImageView.frame.size.width,
                                                  self.mainImageView.frame.size.height)];
  CGContextMoveToPoint(UIGraphicsGetCurrentContext(), fromPoint.x, fromPoint.y);
  CGContextAddLineToPoint(UIGraphicsGetCurrentContext(), toPoint.x, toPoint.y);
  CGContextSetLineCap(UIGraphicsGetCurrentContext(), kCGLineCapRound);
  CGContextSetLineWidth(UIGraphicsGetCurrentContext(), 10.0);
  CGContextSetRGBStrokeColor(UIGraphicsGetCurrentContext(), 1, 1, 1, 1);
  CGContextSetBlendMode(UIGraphicsGetCurrentContext(), kCGBlendModeNormal);
  CGContextStrokePath(UIGraphicsGetCurrentContext());
  CGContextFlush(UIGraphicsGetCurrentContext());
  self.mainImageView.image = UIGraphicsGetImageFromCurrentImageContext();
  UIGraphicsEndImageContext();
}

- (void)touchesBegan:(NSSet *)touches withEvent:(nullable UIEvent *)event {
  UITouch *touch = [touches anyObject];
  self.lastPoint = [touch locationInView:self.mainImageView];
  NSTimeInterval time = [touch timestamp];
  self.points = [NSMutableArray array];
  [self.points addObject:[[MLKStrokePoint alloc] initWithX:self.lastPoint.x
                                                         y:self.lastPoint.y
                                                         t:time * kMillisecondsPerTimeInterval]];
  [self drawLineFrom:self.lastPoint to:self.lastPoint];
}

- (void)touchesMoved:(NSSet *)touches withEvent:(nullable UIEvent *)event {
  UITouch *touch = [touches anyObject];
  CGPoint currentPoint = [touch locationInView:self.mainImageView];
  NSTimeInterval time = [touch timestamp];
  [self.points addObject:[[MLKStrokePoint alloc] initWithX:currentPoint.x
                                                         y:currentPoint.y
                                                         t:time * kMillisecondsPerTimeInterval]];
  [self drawLineFrom:self.lastPoint to:currentPoint];
  self.lastPoint = currentPoint;
}

- (void)touchesEnded:(NSSet *)touches withEvent:(nullable UIEvent *)event {
  UITouch *touch = [touches anyObject];
  CGPoint currentPoint = [touch locationInView:self.mainImageView];
  NSTimeInterval time = [touch timestamp];
  [self.points addObject:[[MLKStrokePoint alloc] initWithX:currentPoint.x
                                                         y:currentPoint.y
                                                         t:time * kMillisecondsPerTimeInterval]];
  [self drawLineFrom:self.lastPoint to:currentPoint];
  self.lastPoint = currentPoint;
  if (self.strokes == nil) {
    self.strokes = [NSMutableArray array];
  }
  [self.strokes addObject:[[MLKStroke alloc] initWithPoints:self.points]];
  self.points = nil;
  [self doRecognition];
}

コード スニペットには、UIImageView にストロークを描画するサンプル関数が含まれています。この機能は、アプリケーションのニーズに合わせて調整する必要があります。線分を描画する際には、キャップを大文字にして、長さがゼロのセグメントをドットとして描画することをおすすめします(小文字の「i」のドットと考えることができます)。doRecognition() 関数は、各ストロークの記述後に呼び出され、以下に定義します。

DigitalInkRecognizer のインスタンスを取得する

認識を行うには、Ink オブジェクトを DigitalInkRecognizer インスタンスに渡す必要があります。DigitalInkRecognizer インスタンスを取得するには、まず目的の言語の認識モデルをダウンロードし、モデルを RAM に読み込む必要があります。これを実現するには、次のコード スニペットを使用します。このコード スニペットでは、わかりやすくするために viewDidLoad() メソッドに配置し、ハードコードされた言語名を使用しています。使用可能な言語のリストをユーザーに表示し、選択した言語をダウンロードする方法の例については、クイックスタート アプリをご覧ください。

Swift

override func viewDidLoad() {
  super.viewDidLoad()
  let languageTag = "en-US"
  let identifier = DigitalInkRecognitionModelIdentifier(forLanguageTag: languageTag)
  if identifier == nil {
    // no model was found or the language tag couldn't be parsed, handle error.
  }
  let model = DigitalInkRecognitionModel.init(modelIdentifier: identifier!)
  let modelManager = ModelManager.modelManager()
  let conditions = ModelDownloadConditions.init(allowsCellularAccess: true,
                                         allowsBackgroundDownloading: true)
  modelManager.download(model, conditions: conditions)
  // Get a recognizer for the language
  let options: DigitalInkRecognizerOptions = DigitalInkRecognizerOptions.init(model: model)
  recognizer = DigitalInkRecognizer.digitalInkRecognizer(options: options)
}

Objective-C

- (void)viewDidLoad {
  [super viewDidLoad];
  NSString *languagetag = @"en-US";
  MLKDigitalInkRecognitionModelIdentifier *identifier =
      [MLKDigitalInkRecognitionModelIdentifier modelIdentifierForLanguageTag:languagetag];
  if (identifier == nil) {
    // no model was found or the language tag couldn't be parsed, handle error.
  }
  MLKDigitalInkRecognitionModel *model = [[MLKDigitalInkRecognitionModel alloc]
                                          initWithModelIdentifier:identifier];
  MLKModelManager *modelManager = [MLKModelManager modelManager];
  [modelManager downloadModel:model conditions:[[MLKModelDownloadConditions alloc]
                                                initWithAllowsCellularAccess:YES
                                                allowsBackgroundDownloading:YES]];
  MLKDigitalInkRecognizerOptions *options =
      [[MLKDigitalInkRecognizerOptions alloc] initWithModel:model];
  self.recognizer = [MLKDigitalInkRecognizer digitalInkRecognizerWithOptions:options];
}

このクイックスタート アプリには、複数のダウンロードを同時に処理する方法と、完了通知を処理することでどのダウンロードが成功したかを確認する方法を示すコードも含まれています。

Ink オブジェクトを認識する

次に、doRecognition() 関数を使用します。この関数は、わかりやすくするために touchesEnded() から呼び出しています。他のアプリケーションでは、タイムアウト後、またはユーザーがボタンをトリガーして認識をトリガーしたときにのみ、認識を呼び出すことができます。

Swift

func doRecognition() {
  let ink = Ink.init(strokes: strokes)
  recognizer.recognize(
    ink: ink,
    completion: {
      [unowned self]
      (result: DigitalInkRecognitionResult?, error: Error?) in
      var alertTitle = ""
      var alertText = ""
      if let result = result, let candidate = result.candidates.first {
        alertTitle = "I recognized this:"
        alertText = candidate.text
      } else {
        alertTitle = "I hit an error:"
        alertText = error!.localizedDescription
      }
      let alert = UIAlertController(title: alertTitle,
                                  message: alertText,
                           preferredStyle: UIAlertController.Style.alert)
      alert.addAction(UIAlertAction(title: "OK",
                                    style: UIAlertAction.Style.default,
                                  handler: nil))
      self.present(alert, animated: true, completion: nil)
    }
  )
}

Objective-C

- (void)doRecognition {
  MLKInk *ink = [[MLKInk alloc] initWithStrokes:self.strokes];
  __weak typeof(self) weakSelf = self;
  [self.recognizer
      recognizeInk:ink
        completion:^(MLKDigitalInkRecognitionResult *_Nullable result,
                     NSError *_Nullable error) {
    typeof(weakSelf) strongSelf = weakSelf;
    if (strongSelf == nil) {
      return;
    }
    NSString *alertTitle = nil;
    NSString *alertText = nil;
    if (result.candidates.count > 0) {
      alertTitle = @"I recognized this:";
      alertText = result.candidates[0].text;
    } else {
      alertTitle = @"I hit an error:";
      alertText = [error localizedDescription];
    }
    UIAlertController *alert =
        [UIAlertController alertControllerWithTitle:alertTitle
                                            message:alertText
                                     preferredStyle:UIAlertControllerStyleAlert];
    [alert addAction:[UIAlertAction actionWithTitle:@"OK"
                                              style:UIAlertActionStyleDefault
                                            handler:nil]];
    [strongSelf presentViewController:alert animated:YES completion:nil];
  }];
}

モデルのダウンロードの管理

認識モデルのダウンロード方法はすでに見ています。次のコード スニペットは、モデルがすでにダウンロード済みかどうかを確認するか、ストレージ容量の復元が不要になったときにモデルを削除する方法を示しています。

モデルがダウンロード済みかどうかを確認する

Swift

let model : DigitalInkRecognitionModel = ...
let modelManager = ModelManager.modelManager()
modelManager.isModelDownloaded(model)

Objective-C

MLKDigitalInkRecognitionModel *model = ...;
MLKModelManager *modelManager = [MLKModelManager modelManager];
[modelManager isModelDownloaded:model];

ダウンロードしたモデルを削除する

Swift

let model : DigitalInkRecognitionModel = ...
let modelManager = ModelManager.modelManager()

if modelManager.isModelDownloaded(model) {
  modelManager.deleteDownloadedModel(
    model!,
    completion: {
      error in
      if error != nil {
        // Handle error
        return
      }
      NSLog(@"Model deleted.");
    })
}

Objective-C

MLKDigitalInkRecognitionModel *model = ...;
MLKModelManager *modelManager = [MLKModelManager modelManager];

if ([self.modelManager isModelDownloaded:model]) {
  [self.modelManager deleteDownloadedModel:model
                                completion:^(NSError *_Nullable error) {
                                  if (error) {
                                    // Handle error.
                                    return;
                                  }
                                  NSLog(@"Model deleted.");
                                }];
}

テキスト認識の精度を向上させるためのヒント

テキスト認識の精度は言語によって異なります。精度は書き方にも左右されます。デジタルインク認識はさまざまな文体のスタイルを処理するようにトレーニングされていますが、結果はユーザーによって異なります。

テキスト認識機能の精度を向上させる方法は次のとおりです。これらの手法は、絵文字、自動描画、シェイプの描画分類器には適用されません。

書き込みエリア

多くのアプリケーションでは、ユーザー入力用の書き込み領域が明確に定義されています。シンボルの意味は、そのシンボルを含む書き込み領域のサイズに応じて、そのサイズによって部分的に決定されます。たとえば、小文字の「or」と「o」または「c」の区別や、カンマとスラッシュを区別します。

認識領域に書き込み領域の幅と高さを指定すると、精度が向上する可能性があります。ただし、認識領域では、書き込み領域には 1 行のテキストしか含まれていないと想定されています。物理的な書き込み領域が 2 行以上書けるほど広い場合は、テキストの高さを 1 行で見積もった最適な高さである WriteArea を渡すと、結果が向上します。認識機能に渡す WriteArea オブジェクトは、画面上の物理的な書き込み領域と完全に一致する必要はありません。このように ことがあります。

書き込み領域を指定する場合は、ストローク座標と同じ単位で幅と高さを指定します。x,y 座標引数には単位の要件がありません。API はすべての単位を正規化するため、重要なのはストロークの相対的なサイズと位置だけです。システムに適した範囲の座標を自由に渡すことができます。

コンテキスト前

事前コンテキストは、認識しようとしている Ink 内のストロークの直前にあるテキストです。認識機能をサポートするには、前もってコンテキストを伝えます。

たとえば、手書きメモの文字「n」は誤って解釈されることがあります。ユーザーが部分的な単語 "arg" をすでに入力している場合は、そのまま入力を続けることができます。事前コンテキスト - 引数を指定して指定すると、「引数」よりも「引数」を使用する可能性が高いため、曖昧さが解消されます。

事前コンテキストを利用すると、認識機能が単語の区切り(単語間のスペース)を識別しやすくなります。スペース文字を入力することはできますが、描画することはできません。認識機能によって、ある単語が終了し、次の単語がいつ開始されるかを判定するにはどうすればよいでしょうか。ユーザーがすでに「hello」をすでに書いていて、「world」という単語を続けると、認識機能は文字列「world」を返します。ただし、事前コンテキストの「hello」を指定すると、モデルから「hello world」以降の文字列が返されるため、「hello world」のように先頭のスペースを含む文字列が返されます。

コンテキストを含む最長の文字列(スペースを含む)を 20 文字以下で指定してください。文字列が長い場合、認識機能は最後の 20 文字のみを使用します。

次のコードサンプルは、書き込み領域を定義し、RecognitionContext オブジェクトを使用して事前コンテキストを指定する方法を示しています。

Swift

let ink: Ink = ...;
let recognizer: DigitalInkRecognizer =  ...;
let preContext: String = ...;
let writingArea = WritingArea.init(width: ..., height: ...);

let context: DigitalInkRecognitionContext.init(
    preContext: preContext,
    writingArea: writingArea);

recognizer.recognizeHandwriting(
  from: ink,
  context: context,
  completion: {
    (result: DigitalInkRecognitionResult?, error: Error?) in
    if let result = result, let candidate = result.candidates.first {
      NSLog("Recognized \(candidate.text)")
    } else {
      NSLog("Recognition error \(error)")
    }
  })

Objective-C

MLKInk *ink = ...;
MLKDigitalInkRecognizer *recognizer = ...;
NSString *preContext = ...;
MLKWritingArea *writingArea = [MLKWritingArea initWithWidth:...
                                              height:...];

MLKDigitalInkRecognitionContext *context = [MLKDigitalInkRecognitionContext
       initWithPreContext:preContext
       writingArea:writingArea];

[recognizer recognizeHandwritingFromInk:ink
            context:context
            completion:^(MLKDigitalInkRecognitionResult
                         *_Nullable result, NSError *_Nullable error) {
                               NSLog(@"Recognition result %@",
                                     result.candidates[0].text);
                         }];

ストロークの順序付け

認識精度は、ストロークの順序の影響を受けます。認識機能は、人間が自然に書く順序でストロークが発生することを想定しています(たとえば、英語の場合は左から右)。このパターンから外れると(たとえば、最後の単語で始まる英語の文章を書くなど)、正確な結果が得られません。

別の例として、Ink の中央にある単語を削除して別の単語に置き換えた場合です。リビジョンはおそらくセンテンスの中央にありますが、リビジョンのストロークはストローク シーケンスの最後にあります。この場合は、新しく書き込まれた単語を API に個別に送信し、独自のロジックを使用して結果を以前の認識と統合することをおすすめします。

あいまいな形状に対処する

認識機能に渡される形状の意味があいまいな場合もあります。たとえば、角が丸い長方形は、長方形や楕円とみなされます。

こうした不明確なケースは、認識スコアが利用可能な場合、それを使用して対処できます。スコアを付けるのはシェイプ分類器だけです。モデルが非常に信頼できる場合、上位の結果のスコアは 2 番目に良いスコアよりもはるかに高くなります。不確実性がある場合、上位 2 つの結果のスコアは近似値になります。また、形状分類器は、Ink 全体を単一のシェイプとして解釈する点にも留意してください。たとえば、Ink に長方形と楕円が隣り合わせに含まれている場合、認識機能では 1 つの認識候補が 2 つの形状を表すことができないため、どちらか一方(またはまったく異なるもの)が返されます。