Class: ImageCollection

ImageCollection(params)

ImageCollection is a class for utilizing STAC found in collection.json.

Constructor

new ImageCollection(params)

Parameters:
Name Type Description
params Object Conditions for creating an ImageCollection instance.
Properties
Name Type Description
collectionUrl string URL of collection.json
See:

Methods

(async) exists(tid) → {boolean}

Determines whether the timestamp ID exists in the dataset.
Parameters:
Name Type Description
tid string Time ID to check for the presence or absence of data
Returns:
Returns true if it exists, false if it does not exist.
Type
boolean

first() → {string}

Returns the first time ID of the dataset.
Returns:
String that represents the time ID.
Type
string

firstDate() → {Date}

Returns the first timestamp of the dataset as a Date.
Returns:
Date indicating date and time
Type
Date

formatDate(date) → {string}

Returns a string converted to the format of the time ID of the dataset.
Parameters:
Name Type Description
date Date Time object to be converted
Returns:
String that represents the time ID.
Type
string

formattedDate(date) → {string}

Returns a string converted to the date and time format of the dataset.
Parameters:
Name Type Description
date Date Time object to be converted
Returns:
String that represents date and time.
Type
string

getBandIdAll() → {Array.<string>}

Returns all band IDs in the dataset.
Returns:
Array of Band ID Strings
Type
Array.<string>

getBbox() → {BboxObject}

Returns the latitude and longitude range of the entire dataset.
Returns:
BboxObject that represents a latitude and longitude range.
Type
BboxObject

getCollectionUrl() → {string}

Retrieves the URL of the referenced collection.json.
Returns:
URL
Type
string

getDateFormat() → {string}

Returns the date and time format of the dataset.
Returns:
Date and time string
Type
string

(async) getImage(…args) → {Image}

Obtains Image by specifying the date, time, and band name.
Parameters:
Name Type Attributes Description
args Object <repeatable>
 Conditions such as the time for acquiring the Image.
Properties
Name Type Description
tid string A time ID that indicates the date and time. If 'date' is specified, it will be ignored.
date Date A Date object that indicates the date and time. It takes precedence over the specification of tid. The time must be specified in UTC(new Date(Date.UTC(yyyy,mm-1,dd)).
band string String that indicates the band
Returns:
Returns an Image object.
Type
Image

getLicense() → {string}

Returns the license of the dataset.
Returns:
URL of the license
Type
string

getProjection() → {string}

Returns the projection method of the dataset.
Returns:
The string of the name of the projection method.
Type
string

(async) getTemporalId(date) → {string}

Returns the time ID corresponding to the specified time. If there is no data corresponding to the specified date and time, it returns the time ID for the data that exists before that date and time. (For example, if you enter the current time using the new Date() function, the most recent available data in this dataset will be retrieved automatically.)
Parameters:
Name Type Description
date Date Date and time. The time must be specified in UTC(new Date(Date.UTC(yyyy,mm-1,dd)).
Returns:
Returns a string that represents the time ID.
Type
string

(async) getTemporalIdAll(start, end) → {Array.<string>}

Returns all time IDs that exist within the specified time range (start <= date < end).
Parameters:
Name Type Description
start Date Start date and time. The time must be specified in UTC(new Date(Date.UTC(yyyy,mm-1,dd).
end Date End date and time. The time must be specified in UTC(new Date(Date.UTC(yyyy,mm-1,dd)).
Returns:
Returns an array of strings representing time IDs.
Type
Array.<string>

getTitle() → {string}

Returns the title of the dataset.
Returns:
String of the title
Type
string

(async) init()

Initializing. Since STAC data is acquired during this process, execution is mandatory.

last() → {string}

Returns the latest time ID of the dataset.
Returns:
A string representing the time ID
Type
string

lastDate() → {Date}

Returns the latest time in the dataset as a Date.
Returns:
Date representing the date and time
Type
Date

(async) next(tid) → {string}

Returns the next time ID.
Parameters:
Name Type Description
tid string Time ID serving as the search criterion
Returns:
String representing a time ID
Type
string

(async) nextAll(tid, size) → {Array.<string>}

Returns the required number of time IDs that come after the specified time ID.
Parameters:
Name Type Description
tid string Time ID used as the search criterion
size number Number of cases
Returns:
Returns an array of strings representing time IDs.
Type
Array.<string>

parseDate(tid) → {string}

Returns the time indicated by the time ID as a Date object.
Parameters:
Name Type Description
tid string Target time ID for conversion
Returns:
Date object representing a time
Type
string

(async) prev(tid) → {string}

Returns the previous time ID.
Parameters:
Name Type Description
tid string Time ID used as the search criterion
Returns:
A string representing the time ID
Type
string

(async) prevAll(tid, size) → {Array.<string>}

Returns the required number of time IDs that are before the specified time ID.
Parameters:
Name Type Description
tid string Time ID used as the search criterion
size number Number of cases
Returns:
Returns an array of strings representing time IDs.
Type
Array.<string>