nsrdb.albedo.ims.ImsFileAcquisition

class ImsFileAcquisition(date, path, shape=None, gap_fill=False)

Bases: object

Class to IMS data file for requested day. Attempts to get data from disk first. If not on disk the data is downloaded.

Files are acquired and loaded by calling self.get_file() after class is initialized. ImsDataNotFoundError is raised if there is any issue obtaining or loading data.

It should be noted that for dates on and after 2014, 336, (Ver 1.3) the file date is one day after the data date.

self.filename

Path and filename for IMS data file

Type:

str

self.res

Resolution of data

Type:

str

self.ver

Version of IMS data

Type:

str

self.shape

Shape of data in (rows, cols)

Type:

(int, int)

self.data

IMS data

Type:

numpy.ndarray

Parameters:

• date (Datetime object) – Desired date

• path (str) – Path of/for IMS data on disk

• shape ((int, int) | None) – Tuple of data shape in (rows, cols) format. Defaults to standard values for 1- and 4-km grid. Used for testing.

• gap_fill (bool) – Look for gap-filled file on disk. Don’t attempt to download.

Methods

get_file()

Check if IMS data is on disk and download if necessary.

Attributes

EARLIEST_1KM
EARLIEST_4KM
EARLIEST_VER_1_2
EARLIEST_VER_1_3
FILE_PATTERN
PIXELS
data	Return IMS data if loaded

property data

Return IMS data if loaded

Returns:

numpy.ndarray – IMS Data

get_file()

Check if IMS data is on disk and download if necessary.