View Source GoogleApi.ContentWarehouse.V1.Model.VideoContentSearchOnScreenTextFeature (google_api_content_warehouse v0.4.0)

Keep feature values which are useful to filter titles, labels.

Attributes

  • shotInfoCountDuringText (type: integer(), default: nil) -
  • averageFontweight (type: number(), default: nil) -
  • countingNumber (type: integer(), default: nil) - Counting number in this anchor's original label.
  • backgroundBlue (type: number(), default: nil) -
  • relativeShotTimeMsPriorToEndTime (type: integer(), default: nil) -
  • topOcrLanguage (type: String.t, default: nil) - OCR language that has the highest weight.
  • relativeShotTimeMsPosteriorToStartTime (type: integer(), default: nil) -
  • averageAngle (type: number(), default: nil) - The average of rotation angles (degree) of texts.
  • durationMs (type: integer(), default: nil) - Duration time in millisec.
  • centerVerticalPositionRatio (type: number(), default: nil) - Vertical position of the center of this text, by ratio [0.0, 1.0].
  • countingNumberOooRatio (type: number(), default: nil) - # of numbered anchors that are not out-of-order / # of all the numbered anchors. If no counting number is detected, this will be empty.
  • medianClusteringDistance (type: number(), default: nil) - The median distance between this anchor and other anchors in the cluster. The way the distance is calculated will vary depending on the clustering method.
  • foregroundRed (type: number(), default: nil) -
  • handwrittenTextRatio (type: number(), default: nil) - # of LINE entities that are recognized as handwritten texts over # of merged LINE entities.
  • averageFontsize (type: number(), default: nil) - Font size or weight information. This is extracted from internal message, so may not be available in future.
  • backgroundGreen (type: number(), default: nil) -
  • averageHeightRatio (type: number(), default: nil) -
  • occurrenceRatio (type: number(), default: nil) - occurrence_count over the number of anchors merged to this anchor.
  • backgroundRed (type: number(), default: nil) -
  • nTextsInSameFrame (type: integer(), default: nil) - # of OCR texts that appear in the same frame. If duration of this OCR text is not zero, the maximum number among multiple frames where this OCR text appears is set to this field.
  • relativeShotTimeMsPriorToStartTime (type: integer(), default: nil) - Shot boundary time nearest to OnScreenText's start and end time. The time is relative to each OnScreenText's start / end time (ex. -1 means shot time exists prior to the start / end time). If shot time and start/end time is the same, 0 is set in 'prior' field. If no shot info is available, the below fields are not set.
  • originalLabel (type: String.t, default: nil) - The label this VideoAnchor originally had before label clearning steps.
  • countingNumberPrefix (type: String.t, default: nil) - Prefix for counting number in this anchor's label. If no counting number is detected, this will be empty.
  • relativeShotTimeMsPosteriorToEndTime (type: integer(), default: nil) -
  • centerHorizontalPositionRatio (type: number(), default: nil) - Horizontal position of the center of this text, by ratio [0.0, 1.0].
  • averageConfidence (type: number(), default: nil) - Average value of confidence.
  • occurrenceCount (type: number(), default: nil) - The number of OCR texts that have the same text among temporally-merged OCR texts.
  • mergedLineCount (type: integer(), default: nil) - The number of LINE entities used for this text.
  • boxHeightRatio (type: number(), default: nil) -
  • ocrAsrFeature (type: GoogleApi.ContentWarehouse.V1.Model.VideoContentSearchOcrAsrFeature.t, default: nil) - Features for the overlap between OCR and ASR.
  • hadUrlInLabel (type: boolean(), default: nil) - Whether or not this anchor had URL in its label before the label fixing step.
  • leftPositionRatio (type: number(), default: nil) - Left position of this text, by ratio [0, 1].
  • backgroundGray (type: number(), default: nil) -
  • isCountingNumberOoo (type: boolean(), default: nil) - Whether or not the counting number in this anchor's label is out-of-order. If no counting number is detected, this will be empty.
  • topPositionRatio (type: number(), default: nil) - Note that top-left position is (0, 0) for position values. Top position of this text, by ratio [0, 1].
  • foregroundGray (type: number(), default: nil) - Color information, normalized to [0-1]. This color information is extracted from the largest word in the line entities of PageLayout message. See goodoc::PageLayoutEntity::Colors for details.
  • foregroundGreen (type: number(), default: nil) -
  • languages (type: list(GoogleApi.ContentWarehouse.V1.Model.GoodocLanguageCombinationLanguage.t), default: nil) - Languages predicted by OCR. "repeated" is employed for this field because LINE entities of PageLayout message are sometimes annotated with multiple languages, and also two VideoAnchor that are annotated with different languages can be merged into one VideoAnchor. When two VideoAnchor are merged into one, the weight field values of the new VideoAnchor will be the average of weight field values weighted by merged_line_count.
  • foregroundBlue (type: number(), default: nil) -
  • countingNumberSuffix (type: String.t, default: nil) - Suffix for counting number in this anchor's label. If no counting number is detected, this will be empty.
  • boxWidthRatio (type: number(), default: nil) - Box width and height ratio, against to the frame size, so the value range is [0, 1]. If this text feature consists of multiple text boxes, the box width / height is a union of each text box.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() ::
  %GoogleApi.ContentWarehouse.V1.Model.VideoContentSearchOnScreenTextFeature{
    averageAngle: number() | nil,
    averageConfidence: number() | nil,
    averageFontsize: number() | nil,
    averageFontweight: number() | nil,
    averageHeightRatio: number() | nil,
    backgroundBlue: number() | nil,
    backgroundGray: number() | nil,
    backgroundGreen: number() | nil,
    backgroundRed: number() | nil,
    boxHeightRatio: number() | nil,
    boxWidthRatio: number() | nil,
    centerHorizontalPositionRatio: number() | nil,
    centerVerticalPositionRatio: number() | nil,
    countingNumber: integer() | nil,
    countingNumberOooRatio: number() | nil,
    countingNumberPrefix: String.t() | nil,
    countingNumberSuffix: String.t() | nil,
    durationMs: integer() | nil,
    foregroundBlue: number() | nil,
    foregroundGray: number() | nil,
    foregroundGreen: number() | nil,
    foregroundRed: number() | nil,
    hadUrlInLabel: boolean() | nil,
    handwrittenTextRatio: number() | nil,
    isCountingNumberOoo: boolean() | nil,
    languages:
      [
        GoogleApi.ContentWarehouse.V1.Model.GoodocLanguageCombinationLanguage.t()
      ]
      | nil,
    leftPositionRatio: number() | nil,
    medianClusteringDistance: number() | nil,
    mergedLineCount: integer() | nil,
    nTextsInSameFrame: integer() | nil,
    occurrenceCount: number() | nil,
    occurrenceRatio: number() | nil,
    ocrAsrFeature:
      GoogleApi.ContentWarehouse.V1.Model.VideoContentSearchOcrAsrFeature.t()
      | nil,
    originalLabel: String.t() | nil,
    relativeShotTimeMsPosteriorToEndTime: integer() | nil,
    relativeShotTimeMsPosteriorToStartTime: integer() | nil,
    relativeShotTimeMsPriorToEndTime: integer() | nil,
    relativeShotTimeMsPriorToStartTime: integer() | nil,
    shotInfoCountDuringText: integer() | nil,
    topOcrLanguage: String.t() | nil,
    topPositionRatio: number() | nil
  }

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.