2.1 MtkFile

class MtkFile( filename)
Constructs a new MtkFile object.

>>> m = MtkFile('../Mtk_testdata/in/MISR_AM1_GRP_ELLIPSOID_GM_P037_O029058_AA_F03_0024.hdf')

attr_get( attribute)
Get a file attribute.

>>> m.attr_get('Path_number')
37

attr_list
List of file attributes names.

>>> m.attr_list
['HDFEOSVersion', 'StructMetadata.0', 'Path_number', 'AGP_version_id',
 'DID_version_id', 'Number_blocks', 'Ocean_blocks_size', 'Ocean_blocks.count',
 'Ocean_blocks.numbers', 'SOM_parameters.som_ellipsoid.a',
 'SOM_parameters.som_ellipsoid.e2', 'SOM_parameters.som_orbit.aprime',
 'SOM_parameters.som_orbit.eprime', 'SOM_parameters.som_orbit.gama',
 'SOM_parameters.som_orbit.nrev', 'SOM_parameters.som_orbit.ro',
 'SOM_parameters.som_orbit.i', 'SOM_parameters.som_orbit.P2P1',
 'SOM_parameters.som_orbit.lambda0', 'Origin_block.ulc.x',
 'Origin_block.ulc.y', 'Origin_block.lrc.x', 'Origin_block.lrc.y',
 'Start_block', 'End block', 'Cam_mode', 'Num_local_modes',
 'Local_mode_site_name', 'Orbit_QA', 'Camera', 'coremetadata']

block
Start and end block numbers.

>>> m.block
(1, 140)

block_metadata_list
List of block metadata structure names.

>>> m.block_metadata_list
['PerBlockMetadataCommon', 'PerBlockMetadataRad', 'PerBlockMetadataTime']

block_metadata_field_list( blockmetaname)
List fields in a block metadata structure.

>>> m.block_metadata_field_list('PerBlockMetadataCommon')
['Block_number', 'Ocean_flag', 'Block_coor_ulc_som_meter.x',
 'Block_coor_ulc_som_meter.y', 'Block_coor_lrc_som_meter.x',
 'Block_coor_lrc_som_meter.y', 'Data_flag']

block_metadata_field_read( blockmetaname, fieldname)
Read a block metadata field.

>>> m.block_metadata_field_read('PerBlockMetadataCommon', 'Block_number')
[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21,
 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40,
 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78,
 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97,
 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113,
 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128,
 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140]

core_metadata_get( parameter)
Get core metadata parameter.

>>> m.core_metadata_get('LOCALGRANULEID')
'MISR_AM1_GRP_ELLIPSOID_GM_P037_O029058_AA_F03_0024.hdf'

core_metadata_list
List of core metadata parameter names.

>>> m.core_metadata_list
['LOCALGRANULEID', 'PRODUCTIONDATETIME', 'LOCALVERSIONID', 'PGEVERSION',
 'MEASUREDPARAMETERCONTAINER', 'AUTOMATICQUALITYFLAGEXPLANATION',
 'AUTOMATICQUALITYFLAG', 'QAPERCENTMISSINGDATA', 'PARAMETERNAME',
 'ORBITCALCULATEDSPATIALDOMAINCONTAINER', 'EQUATORCROSSINGDATE',
 'EQUATORCROSSINGTIME', 'ORBITNUMBER', 'EQUATORCROSSINGLONGITUDE',
 'VERSIONID', 'SHORTNAME', 'INPUTPOINTER', 'GPOLYGONCONTAINER',
 'GRINGPOINTLONGITUDE', 'GRINGPOINTLATITUDE', 'GRINGPOINTSEQUENCENO',
 'EXCLUSIONGRINGFLAG', 'RANGEENDINGDATE', 'RANGEENDINGTIME',
 'RANGEBEGINNINGDATE', 'RANGEBEGINNINGTIME', 'ADDITIONALATTRIBUTESCONTAINER',
 'ADDITIONALATTRIBUTENAME', 'PARAMETERVALUE', 'ADDITIONALATTRIBUTESCONTAINER',
 'ADDITIONALATTRIBUTENAME', 'PARAMETERVALUE', 'ADDITIONALATTRIBUTESCONTAINER',
 'ADDITIONALATTRIBUTENAME', 'PARAMETERVALUE', 'ADDITIONALATTRIBUTESCONTAINER',
 'ADDITIONALATTRIBUTENAME', 'PARAMETERVALUE',
 'ASSOCIATEDPLATFORMINSTRUMENTSENSORCONTAINER',
 'ASSOCIATEDSENSORSHORTNAME', 'ASSOCIATEDPLATFORMSHORTNAME', 'OPERATIONMODE',
 'ASSOCIATEDINSTRUMENTSHORTNAME']

file_name
File name of file.

>>> m.file_name
'../Mtk_testdata/in/MISR_AM1_GRP_ELLIPSOID_GM_P037_O029058_AA_F03_0024.hdf'

file_type
MISR product file type.

>>> m.file_type
'GRP_ELLIPSOID_GM'

grid( grid_name)
Returns MtkGrid object for grid_name.

>>> m.grid('BlueBand')
<MisrToolkit.MtkGrid object at 0x140e740>

grid_list
List of grid names.

>>> m.grid_list
['BlueBand', 'GreenBand', 'RedBand', 'NIRBand', 'BRF Conversion Factors', 'GeometricParameters']

local_granule_id
Local granual ID of MISR product file.

>>> m.local_granule_id
'MISR_AM1_GRP_ELLIPSOID_GM_P037_O029058_AA_F03_0024.hdf'

orbit
Orbit number.

>>> m.orbit
29058

path
Path number.

>>> m.path
37

time_metadata_read( )
Read time metadata from L1B2 Ellipsoid product.

>>> m.time_metadata_read()
<MisrToolkit.MtkTimeMetaData object at 0x158f000>

Note: Time metadata is stored in the L1B2 Ellipsoid product, it is not available in any other product.

version
MISR product file version.

>>> m.version
'F03_0024'