ImageAnalysis::ImageAnalysisResult クラス

class ImageAnalysis::ImageAnalysisResult
  : public Core::_detail::ResultBase< ImageAnalysisCoreResultReason, ImageAnalysisResultProperties >

画像分析操作の結果を表します。

常に GetReason を呼び出して、分析操作が成功したかどうかを判断します。 分析操作が成功すると、このオブジェクトの該当する Get メソッドは、選択した機能 (ImageAnalysisOptions::SetFeatures) またはカスタムトレーニング済みモデル (ImageAnalysisOptions::SetModelName) に基づいて結果を返します。 これらの結果は、サービス JSON 応答から解析されます。 その他の Get メソッドでは、値のない Null 許容の結果オブジェクトが返されます。 結果に値があるかどうかを示す便利なコンテナーとして、Nullable クラスを使用して結果を保持します (「Nullable::HasValue」を参照)。 ImageAnalysisResultDetails::FromResult を呼び出して、生の JSON 応答など、結果に関する追加情報にアクセスします。 分析操作が失敗した場合は、ImageAnalysisErrorDetails::FromResult を呼び出して、エラーに関する追加情報にアクセスします。

メンバー

プロパティ

構文: public const ImageAnalysisResultProperties & Properties;

結果の追加のプロパティのコレクションを取得します。

~ImageAnalysisResult

構文: public ~ImageAnalysisResult ( ) = default;

ImageAnalysisResult クラスのインスタンスを破棄します。

GetReason

構文: public inline ImageAnalysisResultReason GetReason ( ) const;

この結果が生成された理由を示す値を取得します。

戻り値

この結果の理由。

GetModelVersion

構文: public inline Nullable< std::string > GetModelVersion ( );

この結果を作成するために Image Analysis Service によって使用されるモデル バージョンを取得します。

戻り値

モデルのバージョン。

GetImageHeight

構文: public inline Nullable< int32_t > GetImageHeight ( );

分析された画像の高さをピクセル単位で取得します。

戻り値

高さを表すint32_t値、または空の値を保持する Null 許容オブジェクト

画像が正常に分析された場合にのみ設定されます

GetImageWidth

構文: public inline Nullable< int32_t > GetImageWidth ( );

分析された画像の幅をピクセル単位で取得します。 イメージが正常に分析された場合にのみ設定されます。

戻り値

幅を表すint32_t値または空の値を保持する Null 許容オブジェクト

GetCaption

構文: public inline Nullable< ContentCaption > GetCaption ( );

分析された画像の内容を記述する生成されたフレーズを取得します。

この結果は、ImageAnalysisOptions::SetFeatures の呼び出し中に ImageAnalysisFeature::Caption が含まれていた場合にのみ設定されます。

戻り値

ContentCaption の結果または空の値を保持する Null 許容オブジェクト

GetDenseCaptions

構文: public inline Nullable< DenseCaptions > GetDenseCaptions ( );

最大 10 個の生成されたフレーズを取得します。最初に画像全体のコンテンツを記述し、他の語句は画像のさまざまな領域のコンテンツを記述します。

この結果は、ImageAnalysisOptions::SetFeatures の呼び出し中に ImageAnalysisFeature::D enseCaptions が含まれていた場合にのみ設定されます。

戻り値

DenseCaptions の結果または空の値を保持する Null 許容オブジェクト

GetObjects

構文: public inline Nullable< DetectedObjects > GetObjects ( );

分析された画像から検出されたオブジェクトの一覧を取得します。

この結果は、ImageAnalysisOptions::SetFeatures の呼び出し中に ImageAnalysisFeature::Objects が含まれていた場合にのみ設定されます。

戻り値

DetectedObjects の結果または空の値を保持する Null 許容オブジェクト

戻り値

GetCustomObjects

構文: public inline Nullable< DetectedObjects > GetCustomObjects ( );

指定されたカスタムトレーニング済みモデルを使用して、分析された画像から検出されたオブジェクトの一覧を取得します。

この結果は、ImageAnalysisOptions::SetModelName が呼び出され、指定されたカスタム モデルがオブジェクトを検出するようにトレーニングされた場合に設定される可能性があります。

戻り値

DetectedObjects の結果または空の値を保持する Null 許容オブジェクト

戻り値

GetText

構文: public inline Nullable< DetectedText > GetText ( );

分析された画像から抽出されたテキスト行と単語のコレクションを取得します。

この結果は、ImageAnalysisOptions::SetFeatures の呼び出し中に ImageAnalysisFeature::Text が含まれていた場合にのみ設定されます。

戻り値

DetectedText の結果または空の値を保持する Null 許容オブジェクト。

GetTags

構文: public inline Nullable< ContentTags > GetTags ( );

分析された画像からコンテンツ タグ検出の一覧を取得します。

この結果は、ImageAnalysisOptions::SetFeatures の呼び出し中に ImageAnalysisFeature::Tags が含まれていた場合にのみ設定されます。

戻り値

ContentTags の結果または空の値を保持する Null 許容オブジェクト。

GetCustomTags

構文: public inline Nullable< ContentTags > GetCustomTags ( );

指定されたカスタムトレーニング済みモデルを使用して、分析された画像からコンテンツ タグ検出の一覧を取得します。

この結果は、ImageAnalysisOptions::SetModelName が呼び出され、指定されたカスタム モデルがタグを検出するようにトレーニングされた場合に設定される可能性があります。

戻り値

ContentTags の結果または空の値を保持する Null 許容オブジェクト。

GetPeople

構文: public inline Nullable< DetectedPeople > GetPeople ( );

分析された画像から検出されたユーザーの一覧を取得します。

この結果は、ImageAnalysisOptions::SetFeatures の呼び出し中に ImageAnalysisFeature::Peopleが含まれていた場合にのみ設定されます。

戻り値

DetectedPeople の結果または空の値を保持する Null 許容オブジェクト。

GetCropSuggestions

構文: public inline Nullable< CropSuggestions > GetCropSuggestions ( );

目的の縦横比で分析された画像の推奨される画像トリミング操作の一覧を取得します (指定されている場合)

SmartCrops とも言います。 これらのトリミング候補は、指定された縦横比 (指定されている場合) を達成しながら、できるだけ多くのコンテンツを保持します。

この結果は、ImageAnalysisOptions::SetFeatures の呼び出し中に ImageAnalysisFeature::CropSuggestions が含まれていた場合にのみ設定されます。

必要に応じて、ImageAnalysisOptions::SetCroppingAspectRatios を呼び出して、必要なトリミング縦横比を 1 つ以上指定します。 CroppingAspectRatios が設定されていない場合、サービスは縦横比が合った 1 つのトリミング候補を返します。

戻り値

CropSuggestions の結果または空の値を保持する Null 許容オブジェクト。

GetSegmentationResult

構文: public inline Nullable< SegmentationResult > GetSegmentationResult ( );

画像のセグメント化操作の結果を取得します。

この結果は、ImageAnalysisOptions::SetSegmentationMode() が ImageSegmentationMode::BackgroundRemoval または ImageSegmentationMode::ForegroundMatting のいずれかで呼び出された場合にのみ設定されます。

戻り値

SegmentationResult または空の値を保持する Null 許容オブジェクト。