Package geobricks_modis :: Package core :: Module modis_core

[frames] | no frames]

Module modis_core

source code

Functions

[hide private]

get_modis_product_table()
Parse the MODIS product list.

source code

list_products()
List all the available MODIS products.

source code

list_years(product_name)
List all the available years for a given MODIS product.

source code

list_days(product_name, year)
List all the available days for a given MODIS product and year.

source code

list_layers(product_name, year, day)
List all the available layers for a given MODIS product, year and day.

source code

list_layers_subset(product_name, year, day, from_h, to_h, from_v, to_v)
List all the available layers for a given MODIS product, year and day.

source code

is_layer_in_the_range(file_name, from_h, to_h, from_v, to_v)
Check whether a given file is in the specified range, according to its name.

source code

list_countries()

source code

list_layers_countries_subset(product_name, year, day, countries)
List all the available layers for a given MODIS product, year and day.

source code

day_of_the_year_to_date(day, year)
Convert a day of an year to a date

source code

Variables

[hide private]

__package__ = 'geobricks_modis.core'

Function Details

[hide private]

get_modis_product_table()

source code

Parse the MODIS product list.

Returns:: Dictionary with the MODIS product list.

list_products()

source code

List all the available MODIS products.

Returns:: An array of code/label objects.

list_years(product_name)

source code

List all the available years for a given MODIS product.

Parameters:

product_name - Code of MODIS product, e.g. 'MOD13Q1'

Returns:

An array of code/label objects.

list_days(product_name, year)

source code

List all the available days for a given MODIS product and year.

Parameters:

product_name - Code of MODIS product, e.g. 'MOD13Q1'
year - e.g. '2010'

Returns:

An array of code/label objects.

list_layers(product_name, year, day)

source code

List all the available layers for a given MODIS product, year and day.

Parameters:

product_name - Code of MODIS product, e.g. 'MOD13Q1'
year - e.g. '2010'
day - Day of the year, three digits, e.g. '017'

Returns:

An array of code/label/size objects.

list_layers_subset(product_name, year, day, from_h, to_h, from_v, to_v)

source code

List all the available layers for a given MODIS product, year and day.

Parameters:

product_name - Code of MODIS product, e.g. 'MOD13Q1'
year - e.g. '2010'
day - Day of the year, three digits, e.g. '017'
from_h - e.g. '05'
to_h - e.g. '05'
from_v - e.g. '05'
to_v - e.g. '05'

Returns:

An array of code/label/size objects.

is_layer_in_the_range(file_name, from_h, to_h, from_v, to_v)

source code

Check whether a given file is in the specified range, according to its name.

Parameters:

file_name - Name of the file.
from_h - Starting horizontal index of the range.
to_h - Ending horizontal index of the range.
from_v - Starting vertical index of the range.
to_v - Ending vertical index of the range.

Returns:

True if the file is in the range, false otherwise.

list_layers_countries_subset(product_name, year, day, countries)

source code

List all the available layers for a given MODIS product, year and day.

Parameters:

product_name - Code of MODIS product, e.g. 'MOD13Q1'
year - e.g. '2010'
day - Day of the year, three digits, e.g. '017'
countries (String, comma separated) - GAUL codes, comma separated e.g. '18,25,34'

Returns:

An array of code/label/size objects.

day_of_the_year_to_date(day, year)

source code

Convert a day of an year to a date

Parameters:

day - day of the year @type string i.e. "020" or "20"
year - year of reference @type string or int i.e. "2014" or 2014

Returns:

the date of the day/year i.e. "2012-01-20"