The mipp API

MIPP

exception mipp.CalibrationError
exception mipp.ConfigReaderError
exception mipp.DecodeError
exception mipp.MippError
exception mipp.NavigationError
exception mipp.NoFiles
exception mipp.ReaderError
exception mipp.UnknownSatellite
mipp.strptime()

string, format -> new datetime parsed from a string (like time.strptime()).

Metadata

class mipp.mda.Metadata
dont_eval = ('satnumber',)
ignore_attributes = ()
read(file_name)

Read until empty line, ‘EOH’ or ‘EOF’.

save(file_name)
token = ':'
mipp.mda.mslice(mda)

Configuration

mipp.cfg.read_config(satname, instrument='')

Logging

class mipp.log.NullHandler

Empty handler.

emit(record)

Record a message.

mipp.log.debug_on()

Turn debugging logging on.

mipp.log.get_logger(name)

Return logger with null handle

mipp.log.logging_off()

Turn logging off.

mipp.log.logging_on(level=None)

Turn logging on.

XRIT input layer

MSG

This module will read MSG level1.5 files, format documented in: ‘MSG Level 1.5 Image Data Format Description’, EUM/MSG/ICD/105, v5A, 22 August 2007

mipp.xrit.MSG.read_metadata(prologue, image_files, epilogue)

Selected items from the MSG prologue file.

GOMS

Read Electro L N1 HRIT files.

mipp.xrit.GOMS.read_epiheader(fp)
mipp.xrit.GOMS.read_metadata(prologue, image_files, epilogue)

Selected items from the Electro L N1 prolog file.

mipp.xrit.GOMS.read_proheader(fp)

MTP

This module will read satellit data files in OpenMTP format (eg. Meteosat-7 prolog file). Format described in: ‘The Meteosat Archive; Format Guide No. 1; Basic Imagery: OpenMTP Format’; EUM FG 1; Rev 2.1; April 2000

mipp.xrit.MTP.read_metadata(prologue, image_files)

Selected items from the Meteosat-7 prolog file.

SGS

This module will read satellit data files in SGS (Support Ground Segments) format (eg. GOES, MTSAT). Format described in: ‘MSG Ground Segment LRIT/HRIT Mission Specific Implementation’; EUM/MSG/SPE/057; Issue 6; 21 June 2006

mipp.xrit.SGS.read_metadata(prologue, image_files)

Selected items from the GOES image data files (not much information in prologue).

_xrit

This module will read LRIT/HRIT headers. Format described in: “LRIT/HRIT Global Specification”; CGMS 03; Issue 2.6; 12 August 1999 “MSG Ground Segment LRIT/HRIT Mission Specific Implementation”; EUM/MSG/SPE/057; Issue 6; 21 June 2006

mipp.xrit._xrit.read_prologue(file_name)
mipp.xrit._xrit.read_epilogue(file_name)
mipp.xrit._xrit.read_imagedata(file_name)
mipp.xrit._xrit.read_gts_message(file_name)
mipp.xrit._xrit.read_mpef(file_name)
mipp.xrit._xrit.read_mpef_clm(file_name)
mipp.xrit._xrit.decompress(infile, outdir='.')

Will decompress an XRIT data file and return the path to the decompressed file. It expect to find Eumetsat’s xRITDecompress through the environment variable XRIT_DECOMPRESS_PATH

mipp.xrit._xrit.list(file_name, dump_data=False)

bin_reader

mipp.xrit.bin_reader.read_cds_expanded_time(buf)
mipp.xrit.bin_reader.read_cds_time(buf)
mipp.xrit.bin_reader.read_cuc_time(buf, coarce, fine)
mipp.xrit.bin_reader.read_float4(buf)
mipp.xrit.bin_reader.read_float8(buf)
mipp.xrit.bin_reader.read_int2(buf)
mipp.xrit.bin_reader.read_int4(buf)
mipp.xrit.bin_reader.read_uint1(buf)
mipp.xrit.bin_reader.read_uint2(buf)
mipp.xrit.bin_reader.read_uint4(buf)
mipp.xrit.bin_reader.read_uint8(buf)

loader

class mipp.xrit.loader.ImageLoader(mda, image_files, mask=False, calibrate=False)
raw_slicing(item)

Raw slicing, no rotation of image.

convert

mipp.xrit.convert.dec10216(in_buffer)
mipp.xrit.convert.hrpt_dec10216(in_buffer)

sat

mipp.xrit.sat.load_meteosat07(time_stamp, channel, **kwarg)
mipp.xrit.sat.load_meteosat09(time_stamp, channel, **kwarg)
mipp.xrit.sat.load_goes11(time_stamp, channel, **kwarg)
mipp.xrit.sat.load_goes12(time_stamp, channel, **kwarg)
mipp.xrit.sat.load_goes13(time_stamp, channel, **kwarg)
mipp.xrit.sat.load_mtsat1r(time_stamp, channel, **kwarg)
mipp.xrit.sat.load_mtsat2(time_stamp, channel, **kwarg)
mipp.xrit.sat.load_electrol(time_stamp, channel, **kwarg)
mipp.xrit.sat.load_himawari8(time_stamp, channel, **kwarg)
mipp.xrit.sat.load(satname, time_stamp, channel, **kwarg)
mipp.xrit.sat.load_files(prologue, image_files, epilogue=None, **kwarg)

Metadata

class mipp.xrit.mda.Metadata
ignore_attributes = ('line_offset', 'first_pixel', 'coff', 'loff', 'image_data', 'boundaries')
token = ':'

XSAR input layer

Cosmo Sky-med

mipp.xsar.CSK.read_metadata(xmlbuffer)
mipp.xsar.CSK.read_image(mda, filename=None, mask=True, calibrate=1)

Radarsat-2

class mipp.xsar.RS2.TiePoints(image, geodedic)
mipp.xsar.RS2.read_metadata(xml_file)

Terra-SAR X

mipp.xsar.TSX.read_image(mda, filename=None, mask=True, calibrate=1)
mipp.xsar.TSX.read_metadata(xmlbuffer)

sat

mipp.xsar.sat.load(satname, time_stamp, channel, **kwarg)

Metadata

class mipp.xsar.mda.Metadata
ignore_attributes = ('data', 'calibrate', 'tiepoints')
token = ':'