SpecialMetadata.h File Reference

#include <string>

Go to the source code of this file.

Defines

#define END_METADATA_NAME   (std::string("END_METADATA_NAME"))
#define SPECIAL_METADATA_NAME   (std::string("Special"))
#define ROW_METADATA_NAME   (std::string("Row"))
#define COLUMN_METADATA_NAME   (std::string("Column"))
#define BAND_METADATA_NAME   (std::string("Band"))
#define CENTER_WAVELENGTHS_METADATA_NAME   (std::string("CenterWavelengths"))
#define CENTER_WAVELENGTHS_METADATA_PATH   (SPECIAL_METADATA_NAME + "/" + BAND_METADATA_NAME + "/" + CENTER_WAVELENGTHS_METADATA_NAME)
#define START_WAVELENGTHS_METADATA_NAME   (std::string("StartWavelengths"))
#define START_WAVELENGTHS_METADATA_PATH   (SPECIAL_METADATA_NAME + "/" + BAND_METADATA_NAME + "/" + START_WAVELENGTHS_METADATA_NAME)
#define END_WAVELENGTHS_METADATA_NAME   (std::string("EndWavelengths"))
#define END_WAVELENGTHS_METADATA_PATH   (SPECIAL_METADATA_NAME + "/" + BAND_METADATA_NAME + "/" + END_WAVELENGTHS_METADATA_NAME)
#define WAVELENGTH_DISPLAY_UNITS_METADATA_NAME   (std::string("WavelengthDisplayUnits"))
#define WAVELENGTH_DISPLAY_UNITS_METADATA_PATH   (SPECIAL_METADATA_NAME + "/" + BAND_METADATA_NAME + "/" + WAVELENGTH_DISPLAY_UNITS_METADATA_NAME)
#define NAMES_METADATA_NAME   (std::string("Names"))
#define BAND_NAME_PREFIX_METADATA_NAME   (std::string("BandNamePrefix"))
#define COLLECTION_DATE_TIME_METADATA_NAME   (std::string("CollectionDateTime"))
#define COLLECTION_DATE_TIME_METADATA_PATH   (SPECIAL_METADATA_NAME + "/" + COLLECTION_DATE_TIME_METADATA_NAME)
#define SENSOR_ALTITUDE_METADATA_NAME   (std::string("SensorAltitude"))
#define SENSOR_ALTITUDE_METADATA_PATH   (SPECIAL_METADATA_NAME + "/" + SENSOR_ALTITUDE_METADATA_NAME)
#define SENSOR_UP_ANGLE_METADATA_NAME   (std::string("SensorUpAngle"))
#define SENSOR_UP_ANGLE_METADATA_PATH   (SPECIAL_METADATA_NAME + "/" + SENSOR_UP_ANGLE_METADATA_NAME)
#define TARGET_ALTITUDE_METADATA_NAME   (std::string("TargetAltitude"))
#define TARGET_ALTITUDE_METADATA_PATH   (SPECIAL_METADATA_NAME + "/" + TARGET_ALTITUDE_METADATA_NAME)
#define OFF_NADIR_ANGLE_METADATA_NAME   (std::string("OffNadirAngle"))
#define OFF_NADIR_ANGLE_METADATA_PATH   (SPECIAL_METADATA_NAME + "/" + OFF_NADIR_ANGLE_METADATA_NAME)


Define Documentation

#define BAND_METADATA_NAME   (std::string("Band"))

The key for a DynamicObject used to contain band-oriented metadata.

Any items contained within this dynamic object will be chipped when the RasterElement is chipped. For more details see RasterUtilities::chipMetadata(). Any vectors contained in this item, should be indexed using DimensionDescriptor::getActiveNumber().

Definition at line 53 of file SpecialMetadata.h.

#define BAND_NAME_PREFIX_METADATA_NAME   (std::string("BandNamePrefix"))

The key for a string which contains a common prefix for the names of the associated RasterElement's bands.

If provided, this text will be prepended to the DimensionDescriptor::getOriginalNumber() of a given band before displaying it to the user. This value will not be used if SPECIAL_METADATA_NAME / NAMES_METADATA_NAME has been populated.

Definition at line 148 of file SpecialMetadata.h.

#define CENTER_WAVELENGTHS_METADATA_NAME   (std::string("CenterWavelengths"))

The key for a vector<double> which contains the center wavelengths of the associated RasterElement's bands.

The wavelengths should be in microns.

This vector should always be the size of RasterDataDescriptor::getBandCount(). An importer should specifically populate this vector with RasterFileDescriptor::getBandCount() number of items. The center wavelengths should be populated with the center spectral wavelength for the given band represented by DimensionDescriptor::getActiveNumber().

Definition at line 64 of file SpecialMetadata.h.

#define CENTER_WAVELENGTHS_METADATA_PATH   (SPECIAL_METADATA_NAME + "/" + BAND_METADATA_NAME + "/" + CENTER_WAVELENGTHS_METADATA_NAME)

The complete path for a vector<double> which contains the center wavelengths of the associated RasterElement's bands.

The wavelengths should be in microns.

See also:
CENTER_WAVELENGTHS_METADATA_NAME

Definition at line 72 of file SpecialMetadata.h.

#define COLLECTION_DATE_TIME_METADATA_NAME   (std::string("CollectionDateTime"))

The key for a DateTime which specifies when the associated DataElement was captured.

This key should not be used when there is no clear single date/time associated with the DataElement.

Definition at line 157 of file SpecialMetadata.h.

#define COLLECTION_DATE_TIME_METADATA_PATH   (SPECIAL_METADATA_NAME + "/" + COLLECTION_DATE_TIME_METADATA_NAME)

The full path for a DateTime which specifies when the associated DataElement was captured.

See also:
COLLECTION_DATE_TIME_METADATA_NAME

Definition at line 165 of file SpecialMetadata.h.

#define COLUMN_METADATA_NAME   (std::string("Column"))

The key for a DynamicObject used to contain column-oriented metadata.

Any items contained within this dynamic object will be chipped when the RasterElement is chipped. For more details see RasterUtilities::chipMetadata(). Any vectors contained in this item, should be indexed using DimensionDescriptor::getActiveNumber().

Definition at line 44 of file SpecialMetadata.h.

#define END_METADATA_NAME   (std::string("END_METADATA_NAME"))

Placeholder name for the end of DynamicObject::getAttributeByPath() and DynamicObject::setAttributeByPath().

Definition at line 19 of file SpecialMetadata.h.

#define END_WAVELENGTHS_METADATA_NAME   (std::string("EndWavelengths"))

The key for a vector<double> which contains the end wavelengths of the associated RasterElement's bands.

The wavelengths should be in microns.

This vector should always be the size of RasterDataDescriptor::getBandCount(). An importer should specifically populate this vector with RasterFileDescriptor::getBandCount() number of items. The end wavelengths should be populated with the stopping point of the spectral wavelength for the given band represented by DimensionDescriptor::getActiveNumber().

Definition at line 102 of file SpecialMetadata.h.

#define END_WAVELENGTHS_METADATA_PATH   (SPECIAL_METADATA_NAME + "/" + BAND_METADATA_NAME + "/" + END_WAVELENGTHS_METADATA_NAME)

The complete path for a vector<double> which contains the end wavelengths of the associated RasterElement's bands.

The wavelengths should be in microns.

See also:
END_WAVELENGTHS_METADATA_NAME

Definition at line 110 of file SpecialMetadata.h.

#define NAMES_METADATA_NAME   (std::string("Names"))

The key for a vector<string> which contains the names of the associated RasterElement's bands.

This vector should always be the size of RasterDataDescriptor::getBandCount(). An importer should specifically populate this vector with RasterFileDescriptor::getBandCount() number of items. The band names should be populated with the names of the band that should be displayed to the user. If this value is present, SPECIAL_METADATA_NAME / BAND_NAME_PREFIX_METADATA_NAME will be ignored.

Definition at line 138 of file SpecialMetadata.h.

#define OFF_NADIR_ANGLE_METADATA_NAME   (std::string("OffNadirAngle"))

The key for a double which specifies the off-nadir angle of the sensor when the associated DataElement was captured.

Definition at line 213 of file SpecialMetadata.h.

#define OFF_NADIR_ANGLE_METADATA_PATH   (SPECIAL_METADATA_NAME + "/" + OFF_NADIR_ANGLE_METADATA_NAME)

The full path for a double which specifies the off-nadir angle of the sensor when the associated DataElement was captured.

See also:
OFF_NADIR_ANGLE_METADATA_NAME

Definition at line 221 of file SpecialMetadata.h.

#define ROW_METADATA_NAME   (std::string("Row"))

The key for a DynamicObject used to contain row-oriented metadata.

Any items contained within this dynamic object will be chipped when the RasterElement is chipped. For more details see RasterUtilities::chipMetadata(). Any vectors contained in this item, should be indexed using DimensionDescriptor::getActiveNumber().

Definition at line 35 of file SpecialMetadata.h.

#define SENSOR_ALTITUDE_METADATA_NAME   (std::string("SensorAltitude"))

The key for a double which specifies the altitude of the sensor when the associated DataElement was captured.

Definition at line 171 of file SpecialMetadata.h.

#define SENSOR_ALTITUDE_METADATA_PATH   (SPECIAL_METADATA_NAME + "/" + SENSOR_ALTITUDE_METADATA_NAME)

The full path for a double which specifies the altitude of the sensor when the associated DataElement was captured.

See also:
SENSOR_ALTITUDE_METADATA_NAME

Definition at line 179 of file SpecialMetadata.h.

#define SENSOR_UP_ANGLE_METADATA_NAME   (std::string("SensorUpAngle"))

The key for a double which specifies how many degrees a DataElement must be rotated counterclockwise such that the sensor flight line is pointing at the top of the screen.

Definition at line 185 of file SpecialMetadata.h.

#define SENSOR_UP_ANGLE_METADATA_PATH   (SPECIAL_METADATA_NAME + "/" + SENSOR_UP_ANGLE_METADATA_NAME)

The full path for a double which specifies how many degrees a DataElement must be rotated counterclockwise such that the sensor flight line is pointing at the top of the screen.

See also:
SENSOR_UP_ANGLE_METADATA_NAME

Definition at line 193 of file SpecialMetadata.h.

#define SPECIAL_METADATA_NAME   (std::string("Special"))

The key for a DynamicObject which contains all metadata that is treated specially.

See also:
Special Metadata

Definition at line 26 of file SpecialMetadata.h.

#define START_WAVELENGTHS_METADATA_NAME   (std::string("StartWavelengths"))

The key for a vector<double> which contains the start wavelengths of the associated RasterElement's bands.

The wavelengths should be in microns.

This vector should always be the size of RasterDataDescriptor::getBandCount(). An importer should specifically populate this vector with RasterFileDescriptor::getBandCount() number of items. The start wavelengths should be populated with the starting point of the spectral wavelength for the given band represented by DimensionDescriptor::getActiveNumber().

Definition at line 83 of file SpecialMetadata.h.

#define START_WAVELENGTHS_METADATA_PATH   (SPECIAL_METADATA_NAME + "/" + BAND_METADATA_NAME + "/" + START_WAVELENGTHS_METADATA_NAME)

The complete path for a vector<double> which contains the start wavelengths of the associated RasterElement's bands.

The wavelengths should be in microns.

See also:
START_WAVELENGTHS_METADATA_NAME

Definition at line 91 of file SpecialMetadata.h.

#define TARGET_ALTITUDE_METADATA_NAME   (std::string("TargetAltitude"))

The key for a double which specifies the altitude of the target when the associated DataElement was captured.

Definition at line 199 of file SpecialMetadata.h.

#define TARGET_ALTITUDE_METADATA_PATH   (SPECIAL_METADATA_NAME + "/" + TARGET_ALTITUDE_METADATA_NAME)

The full path for a double which specifies the altitude of the target when the associated DataElement was captured.

See also:
TARGET_ALTITUDE_METADATA_NAME

Definition at line 207 of file SpecialMetadata.h.

#define WAVELENGTH_DISPLAY_UNITS_METADATA_NAME   (std::string("WavelengthDisplayUnits"))

The key for an attribute of type WavelengthUnitsType that contains the wavelength units that should be displayed to the user.

See also:
WAVELENGTH_DISPLAY_UNITS_METADATA_PATH

Definition at line 118 of file SpecialMetadata.h.

#define WAVELENGTH_DISPLAY_UNITS_METADATA_PATH   (SPECIAL_METADATA_NAME + "/" + BAND_METADATA_NAME + "/" + WAVELENGTH_DISPLAY_UNITS_METADATA_NAME)

The complete path for an attribute of type WavelengthUnitsType that contains the wavelength units that should be displayed to the user.

See also:
WAVELENGTH_DISPLAY_UNITS_METADATA_NAME

Definition at line 126 of file SpecialMetadata.h.


Software Development Kit - Opticks 4.9.0 Build 16218