case class Options(tiffExtensions: Seq[String] = ..., crs: Option[CRS] = None, timeTag: String = GEOTIFF_TIME_TAG_DEFAULT, timeFormat: String = GEOTIFF_TIME_FORMAT_DEFAULT, maxTileSize: Option[Int] = Some(DefaultMaxTileSize), numPartitions: Option[Int] = None, partitionBytes: Option[Long] = Some(DefaultPartitionBytes), chunkSize: Option[Int] = None, delimiter: Option[String] = None, getClient: () ⇒ S3Client = S3ClientProducer.get) extends RasterReader.Options with Product with Serializable
This case class contains the various parameters one can set when reading RDDs from S3 using Spark.
TODO: Add persistLevel option
- tiffExtensions
Read all file with an extension contained in the given list.
- crs
Override CRS of the input files. If None, the reader will use the file's original CRS.
- timeTag
Name of tiff tag containing the timestamp for the tile.
- timeFormat
Pattern for java.time.format.DateTimeFormatter to parse timeTag.
- maxTileSize
Maximum allowed size of each tiles in output RDD. May result in a one input GeoTiff being split amongst multiple records if it exceeds this size. If no maximum tile size is specific, then each file is broken into 256x256 tiles. If None, then the whole file will be read in. This option is incompatible with numPartitions and anything set to that parameter will be ignored.
- numPartitions
How many partitions Spark should create when it repartitions the data.
- partitionBytes
Desired partition size in bytes, at least one item per partition will be assigned. If no size is specified, then partitions 128 Mb in size will be created by default. This option is incompatible with the numPartitions option. If both are set and maxTileSize isn't, then partitionBytes will be ignored in favor of numPartitions. However, if maxTileSize is set, then partitionBytes will be retained. If None and maxTileSize is defined, then the default partitionBytes' value will still be used. If maxTileSize is also None, then partitionBytes will remain None as well.
- chunkSize
How many bytes should be read in at a time when reading a file. If None, then 65536 byte chunks will be read in at a time.
- delimiter
Delimiter to use for S3 objet listings. This provides a way to further define what files should be read. If None, then only the prefix will be used when determing which files to read.
- getClient
A function to instantiate an S3Client.
- Alphabetic
- By Inheritance
- Options
- Serializable
- Serializable
- Product
- Equals
- Options
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
Options(tiffExtensions: Seq[String] = ..., crs: Option[CRS] = None, timeTag: String = GEOTIFF_TIME_TAG_DEFAULT, timeFormat: String = GEOTIFF_TIME_FORMAT_DEFAULT, maxTileSize: Option[Int] = Some(DefaultMaxTileSize), numPartitions: Option[Int] = None, partitionBytes: Option[Long] = Some(DefaultPartitionBytes), chunkSize: Option[Int] = None, delimiter: Option[String] = None, getClient: () ⇒ S3Client = S3ClientProducer.get)
- tiffExtensions
Read all file with an extension contained in the given list.
- crs
Override CRS of the input files. If None, the reader will use the file's original CRS.
- timeTag
Name of tiff tag containing the timestamp for the tile.
- timeFormat
Pattern for java.time.format.DateTimeFormatter to parse timeTag.
- maxTileSize
Maximum allowed size of each tiles in output RDD. May result in a one input GeoTiff being split amongst multiple records if it exceeds this size. If no maximum tile size is specific, then each file is broken into 256x256 tiles. If None, then the whole file will be read in. This option is incompatible with numPartitions and anything set to that parameter will be ignored.
- numPartitions
How many partitions Spark should create when it repartitions the data.
- partitionBytes
Desired partition size in bytes, at least one item per partition will be assigned. If no size is specified, then partitions 128 Mb in size will be created by default. This option is incompatible with the numPartitions option. If both are set and maxTileSize isn't, then partitionBytes will be ignored in favor of numPartitions. However, if maxTileSize is set, then partitionBytes will be retained. If None and maxTileSize is defined, then the default partitionBytes' value will still be used. If maxTileSize is also None, then partitionBytes will remain None as well.
- chunkSize
How many bytes should be read in at a time when reading a file. If None, then 65536 byte chunks will be read in at a time.
- delimiter
Delimiter to use for S3 objet listings. This provides a way to further define what files should be read. If None, then only the prefix will be used when determing which files to read.
- getClient
A function to instantiate an S3Client.
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
- val chunkSize: Option[Int]
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- val crs: Option[CRS]
- val delimiter: Option[String]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
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()
- val getClient: () ⇒ S3Client
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val maxTileSize: Option[Int]
-
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()
- val numPartitions: Option[Int]
-
def
parseTime(tags: Tags): ZonedDateTime
- Definition Classes
- Options
- val partitionBytes: Option[Long]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val tiffExtensions: Seq[String]
- val timeFormat: String
-
lazy val
timeFormatter: DateTimeFormatter
- Definition Classes
- Options
- val timeTag: String
-
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()