class ImageDataSource extends AnyRef
image
package implements Spark SQL data source API for loading image data as DataFrame
.
It can load compressed image (jpeg, png, etc.) into raw image representation via ImageIO
in Java library.
The loaded DataFrame
has one StructType
column: image
, containing image data stored
as image schema.
The schema of the image
column is:
- origin:
StringType
(represents the file path of the image) - height:
IntegerType
(height of the image) - width:
IntegerType
(width of the image) - nChannels:
IntegerType
(number of image channels) - mode:
IntegerType
(OpenCV-compatible type) - data:
BinaryType
(Image bytes in OpenCV-compatible order: row-wise BGR in most cases)
To use image data source, you need to set "image" as the format in DataFrameReader
and
optionally specify the data source options, for example:
// Scala val df = spark.read.format("image") .option("dropInvalid", true) .load("/path/to/images") // Java Dataset<Row> df = spark.read().format("image") .option("dropInvalid", true) .load("/path/to/images");
Image data source supports the following options:
- "dropInvalid": Whether to drop the files that are not valid images from the result.
- Source
- ImageDataSource.scala
- Note
This IMAGE data source does not support saving images to files.
,This class is public for documentation purpose. Please don't use this class directly. Rather, use the data source API as illustrated above.
- Alphabetic
- By Inheritance
- ImageDataSource
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()