Class: Xberg::ExtractedImage

Inherits:
Object
  • Object
show all
Defined in:
sig/types.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeExtractedImage

Returns a new instance of ExtractedImage.

Parameters:

  • data: (String)
  • format: (String)
  • image_index: (Integer)
  • page_number: (Integer)
  • width: (Integer)
  • height: (Integer)
  • colorspace: (String)
  • bits_per_component: (Integer)
  • is_mask: (Boolean)
  • description: (String)
  • ocr_result: (ExtractedDocument)
  • bounding_box: (BoundingBox)
  • source_path: (String)
  • image_kind: (enum_ImageKind)
  • kind_confidence: (Float)
  • cluster_id: (Integer)
  • caption: (String)
  • qr_codes: (Array[QrCode])
  • data_base64: (String)


906
# File 'sig/types.rbs', line 906

def initialize: (?data: String, ?format: String, ?image_index: Integer, ?page_number: Integer, ?width: Integer, ?height: Integer, ?colorspace: String, ?bits_per_component: Integer, ?is_mask: bool, ?description: String, ?ocr_result: ExtractedDocument, ?bounding_box: BoundingBox, ?source_path: String, ?image_kind: enum_ImageKind, ?kind_confidence: Float, ?cluster_id: Integer, ?caption: String, ?qr_codes: Array[QrCode], ?data_base64: String) -> void

Instance Attribute Details

#bits_per_componentInteger? (readonly)

Returns the value of attribute bits_per_component.

Returns:

  • (Integer, nil)


893
894
895
# File 'sig/types.rbs', line 893

def bits_per_component
  @bits_per_component
end

#bounding_boxBoundingBox? (readonly)

Returns the value of attribute bounding_box.

Returns:



897
898
899
# File 'sig/types.rbs', line 897

def bounding_box
  @bounding_box
end

#captionString? (readonly)

Returns the value of attribute caption.

Returns:

  • (String, nil)


902
903
904
# File 'sig/types.rbs', line 902

def caption
  @caption
end

#cluster_idInteger? (readonly)

Returns the value of attribute cluster_id.

Returns:

  • (Integer, nil)


901
902
903
# File 'sig/types.rbs', line 901

def cluster_id
  @cluster_id
end

#colorspaceString? (readonly)

Returns the value of attribute colorspace.

Returns:

  • (String, nil)


892
893
894
# File 'sig/types.rbs', line 892

def colorspace
  @colorspace
end

#dataString (readonly)

Returns the value of attribute data.

Returns:

  • (String)


886
887
888
# File 'sig/types.rbs', line 886

def data
  @data
end

#data_base64String? (readonly)

Returns the value of attribute data_base64.

Returns:

  • (String, nil)


904
905
906
# File 'sig/types.rbs', line 904

def data_base64
  @data_base64
end

#descriptionString? (readonly)

Returns the value of attribute description.

Returns:

  • (String, nil)


895
896
897
# File 'sig/types.rbs', line 895

def description
  @description
end

#formatString (readonly)

Returns the value of attribute format.

Returns:

  • (String)


887
888
889
# File 'sig/types.rbs', line 887

def format
  @format
end

#heightInteger? (readonly)

Returns the value of attribute height.

Returns:

  • (Integer, nil)


891
892
893
# File 'sig/types.rbs', line 891

def height
  @height
end

#image_indexInteger (readonly)

Returns the value of attribute image_index.

Returns:

  • (Integer)


888
889
890
# File 'sig/types.rbs', line 888

def image_index
  @image_index
end

#image_kindenum_ImageKind? (readonly)

Returns the value of attribute image_kind.

Returns:

  • (enum_ImageKind, nil)


899
900
901
# File 'sig/types.rbs', line 899

def image_kind
  @image_kind
end

#is_maskBoolean (readonly)

Returns the value of attribute is_mask.

Returns:

  • (Boolean)


894
895
896
# File 'sig/types.rbs', line 894

def is_mask
  @is_mask
end

#kind_confidenceFloat? (readonly)

Returns the value of attribute kind_confidence.

Returns:

  • (Float, nil)


900
901
902
# File 'sig/types.rbs', line 900

def kind_confidence
  @kind_confidence
end

#ocr_resultExtractedDocument? (readonly)

Returns the value of attribute ocr_result.

Returns:



896
897
898
# File 'sig/types.rbs', line 896

def ocr_result
  @ocr_result
end

#page_numberInteger? (readonly)

Returns the value of attribute page_number.

Returns:

  • (Integer, nil)


889
890
891
# File 'sig/types.rbs', line 889

def page_number
  @page_number
end

#qr_codesArray[QrCode]? (readonly)

Returns the value of attribute qr_codes.

Returns:



903
904
905
# File 'sig/types.rbs', line 903

def qr_codes
  @qr_codes
end

#source_pathString? (readonly)

Returns the value of attribute source_path.

Returns:

  • (String, nil)


898
899
900
# File 'sig/types.rbs', line 898

def source_path
  @source_path
end

#widthInteger? (readonly)

Returns the value of attribute width.

Returns:

  • (Integer, nil)


890
891
892
# File 'sig/types.rbs', line 890

def width
  @width
end