Package org.esa.snap.core.datamodel

Contains SNAP's central classes and interfaces used for an in-memory presentation of remote sensing data products.

The Product class plays a central role in SNAP this package and is used throughout the SNAP software in order represent data products of many different types.

Many of the classes in this package are superclasses of the ProductNode, which acts as a base class for all data and metadata items contained in a product. The inheritance hierarchy of the abstract ProductNode is as follows:

• Product
• DataNode
• RasterDataNode
• TiePointGrid
• AbstractBand
• Band
• VirtualBand
• Mask
• FilterBand
• ConvolutionFilterBand
• GeneralFilterBand
• MetadataAttribute
• SampleCoding
• FlagCoding
• IndexCoding
• MetadataElement
• VectorDataNode

Product instances are composed as follows:

• Always one MetadataElement named "metadata"
• Zero or more TiePointGrids
• Zero or more Bands
• Zero or more Masks
• Zero or more SampleCodings
• Zero or more VectorDataNodes
• Zero or one scene GeoCodings

MetadataElement instances are composed as follows:

• Zero or more MetadataElements
• Zero or more MetadataAttributes

Products and RasterDataNodes can have an associated GeoCoding allowing them to geo-locate raster pixel positions with geographic positions and vice versa. There are various possible GeoCoding implementations which all derive from AbstractGeoCoding:

• TiePointGeoCoding - geo-coding based on latitude/longitude TiePointGrids
• PixelGeoCoding - geo-coding based on per-pixel latitude/longitude Bands
• PixelGeoCoding2 - alternative geo-coding based on per-pixel latitude/longitude Bands (current default)
• CrsGeoCoding - geo-coding for reprojected products, i.e. products having raster data rectified w.r.t. geodetic coordinate reference system (CRS)
• GcpGeoCoding - geo-coding based on ground control point Placemarks
• FXYGeoCoding- geo-coding based on X,Y-functions

There are various places in the SNAP API that provide utility functions that deal the above mentioned classes and interfaces.

• ProductUtils - Static utilities methods around the Product and its components
• FeatureUtils - Static utilities methods around the SimpleFeature and Geometry used in conjunction with VectorDataNode

A strongly related packages are org.esa.snap.core.dataio which provides the data product I/O framework and org.esa.snap.core.gpf which is graph processing framework GPF used for developing and executing raster data operators and graphs of such operators.

Interface Summary

Interface	Description
BasicPixelGeoCoding	Deprecated.
GeoCoding	The GeoCoding interface provides geo-spatial latitude and longitude information for a given X/Y position of any (two-dimensional) raster.
PlacemarkDescriptor	Placemark descriptors are used to describe and create Placemarks.
Pointing	The interface Pointing wraps a GeoCoding and optionally provides more geometry information such as sun direction, satellite (view) direction and elevation at a given pixel position.
PointingFactory	A factory which creates instances of a Pointing for a given raster data node.
Product.AutoGrouping	AutoGrouping can be used by an application to auto-group a long list of product nodes (e.g.
ProductFilter	A filter for products.
ProductManager.Listener	A listener for the product manager.
ProductNodeFilter<T extends ProductNode>	A filter for abstract product nodes.
ProductNodeListener	A listener which listens to internal data product changes.
ProductVisitor	A visitor for a product and all other product nodes.
ProgressListener	The ProgressListener interface represents a listener for the observation of possibly time consuming processes.
RasterDataNode.RasterDataProcessor	A raster data processor which is called for a set of raster lines to be processed.
Resampler	An interface for classes that resample a multi-size product to a single-size product.
Scaling	The scaling method used for geophysical value transformation in a Band.
Scene	Represents a geo-coded scene.
SceneTransformProvider	Provides various transformations from local RasterDataNode coordinate reference systems to a Product's scene coordinate reference systems.
TimeCoding	The TimeCoding interface allows to convert pixel coordinates to time values and vice versa (if possible).

Class Summary

Class	Description
AbstractBand	The AbstractBand class provides a set of pixel access methods but does not provide an implementation of the actual reading and writing of pixel data from or into a raster.
AbstractGeoCoding	AbstractGeoCoding is the base class of all geo-coding implementation.
AbstractMaskPersistenceConverter
AbstractPlacemarkDescriptor	The base class for PlacemarkDescriptor implementations.
AngularDirection
Band	A band contains the data for geophysical parameter in remote sensing data products.
BandMathsMaskPersistenceSpi
BasicPixelGeoCodingPersistenceConverter
BasicPixelGeoCodingPersistenceSpi
ColorManipulationDefaults	Configuration which contains many key parameters with defaults and labels for the color manipulation tool
ColorPaletteDef	The ColorPaletteDef class represents a curve that is used to transform the sample values of a geo-physical band into color palette indexes.
ColorPaletteDef.Point
ColorSchemeInfo	Contains all info for a color scheme
CombinedFXYGeoCoding	A geo-coding based on a combination of GeoCodings.
CombinedFXYGeoCoding.CodingWrapper
ConstantTimeCoding	Time coding which returns a constant value.
ConvolutionFilterBand	A band that obtains its input data from an underlying source band and filters the raster data using a Kernel.
ConvolutionFilterBandPersistenceConverter
ConvolutionFilterBandPersistenceSpi
CrsGeoCoding	A geo-coding that is based on a well-known coordinate reference system (CRS) and affine transformation used to locate a product's scene image within the CRS.
DataNode	A DataNode is the base class for all nodes within a data product which carry data.
DensityPlot	Creates an Densityplot from two given bands.
FilterBand	Represents a band that generates its data by using another band as input and performs some kind of operation on this input.
FlagCoding	Provides the information required to decode integer sample values that are combined of single flags (bit indexes).
FXYGeoCoding	A geo-coding based on equations.
FXYGeoCodingPersistenceConverter
FXYGeoCodingPersistenceSpi
GcpDescriptor
GcpGeoCoding	Ground control point (GCP) geo-coding.
GcpGeoCodingPersistenceConverter
GcpGeoCodingPersistenceSpi
GeneralFilterBand	A band that obtains its input data from an underlying source raster and filters its data using a predefined operation type.
GeneralFilterBandPersistenceConverter	Caution! This PersistenceConverter does not support historical dimap variations of GeneralFilterBand.
GeneralFilterBandPersistenceSpi
GenericPlacemarkDescriptor	Used as a fallback for the case that we can't find any suitable PlacemarkDescriptor for a given SimpleFeatureType.
GeoApproximation	Approximates the x(lat, lon) and y(lat, lon) functions.
GeoCodingFactory	Deprecated. since SNAP 8, use ComponentGeoCoding instead
GeoCodingPersistenceHelper
GeometryDescriptor	A PlacemarkDescriptor that is used to create placemarks that are actually plain geometries.
GeoPos	The GeoPos class represents a geographical position measured in longitudes and latitudes.
Graticule	A geometric representation of a geographical grid measured in longitudes and latitudes.
Graticule.TextGlyph
HistogramStxOp	Utility class for the cumulative calculation of histograms from image data.
ImageGeometry
ImageInfo	This class contains information about how a product's raster data node is displayed as an image.
ImageLegend	The ImageLegend class is used to generate an image legend from a ImageInfo instance.
IndexCoding	Provides the information required to decode integer sample values that represent index values (e.g.
Kernel	The Kernel class defines a matrix that describes how a specified pixel and its surrounding pixels affect the value computed for the pixel's position in the output image of a filtering operation.
LineTimeCoding	A time-coding based on an Array of modified julian days as double values.
MapGeoCoding	Deprecated. since BEAM 4.8, use CrsGeoCoding instead.
Mask	A Mask is used to mask image pixels of other raster data nodes.
Mask.BandMathsType	A mask image type which is based on band math.
Mask.ImageType	Specifies a factory for the source image used by a Mask.
Mask.RangeType
Mask.VectorDataType	A mask image type which is based on vector data.
MetadataAttribute	A MetadataAttribute is part of a MetadataElement and represents a key/value pair.
MetadataElement	A MetadataElement is a data node used to store metadata.
PinDescriptor
PixelGeoCoding	Deprecated. since SNAP 8, use ComponentGeoCoding instead
PixelPos	A PixelPos represents a position or point in a pixel coordinate system.
PixelPosEstimator	A class for estimating the pixel position for a given geo-location.
PixelTimeCoding
Placemark	Placemarks are displayed as symbols at the image's pixel position corresponding to their geographical position.
PlacemarkDescriptorRegistry
PlacemarkGroup
PlacemarkNameFactory
PlainFeatureFactory
PointDescriptor
PointingFactoryRegistry
PointPlacemarkDescriptor
Product	Product instances are an in-memory representation of a remote sensing data product.
ProductData	The abstract ProductData class represents a generic data buffer used to hold the actual data values stored in remote sensing data products.
ProductData.ASCII	The ProductData.ASCII class is a ProductData.Byte specialisation representing textual values.
ProductData.Byte	The Byte class is a ProductData specialisation for signed 8-bit integer fields.
ProductData.Double	The ProductData.Float class is a ProductData specialisation for 64-bit floating point fields.
ProductData.Float	The ProductData.Float class is a ProductData specialisation for 32-bit floating point fields.
ProductData.Int	The Int class is a ProductData specialisation for signed 32-bit integer fields.
ProductData.Long	The Long class is a ProductData specialisation for signed 64-bit integer fields.
ProductData.Short	The Short class is a ProductData specialisation for signed 16-bit integer fields.
ProductData.UByte	The UByte class is a ProductData specialisation for unsigned 8-bit integer fields.
ProductData.UInt	The UInt class is a ProductData specialisation for unsigned 32-bit integer fields.
ProductData.UShort	The UShort class is a ProductData specialisation for unsigned 16-bit integer fields.
ProductData.UTC	The ProductData.UTC class is a ProductData.UInt specialisation for UTC date/time values.
ProductManager	A type-safe container for elements of the type Product.
ProductManager.Event	An event object passed into the ProductManager.Listener methods.
ProductNode	The ProductNode is the base class for all nodes within a remote sensing data product and even the data product itself.
ProductNodeEvent	A product node event informs a product change listener about the source of the notification.
ProductNodeGroup<T extends ProductNode>	A type-safe container for elements of the type ProductNode.
ProductNodeList<T extends ProductNode>	A type-safe list for elements of the type ProductNode.
ProductNodeListenerAdapter	A listener adapter which listens to product internal changes.
ProductNodeNameValidator
ProductVisitorAdapter	A default implementation of the ProductVisitor interface.
ProgressListenerList	A utility class for clients interested in the progress made while reading, writing or somehow processing data products.
QualitativeStxOp
RangeTypeMaskPersistenceConverter
RangeTypeMaskPersistenceSpi
RasterDataNode	The RasterDataNode class ist the abstract base class for all objects in the product package that contain rasterized data.
RasterDataNodePersistenceHelper
RationalFunctionModel	Class for approximating a function of two variables with a rational function.
RGBChannelDef
RGBImageProfile	A profile used for the creation of RGB images.
RGBImageProfileManager	A profile used for the creation of RGB images.
Rotator	Class for rotating geographical positions.
SampleCoding	Provides the information required to decode integer sample values that are combined of single flags (bit indexes).
SceneFactory	This class is not public API yet.
Stx	Provides statistic information for a raster data node at a given image resolution level.
StxFactory	The factory for Stx instances.
SummaryStxOp	Utility class for calculating minimum, maximum, mean and standard deviation.
TiePointGeoCoding	Deprecated. since SNAP 8.0.0, Better use ComponentGeoCoding with TiePointInverse and one of TiePointInverse, TiePointBilinearForward and TiePointSplineForward
TiePointGeoCoding.Approximation
TiePointGeoCodingPersistenceConverter
TiePointGeoCodingPersistenceSpi
TiePointGrid	A tie-point grid contains the data for geophysical parameter in remote sensing data products.
TiePointGridPointing	A Pointing which uses tie-point grids to compute the geometry for a given pixel position.
TrackPointDescriptor	Placemark descriptor implementation for handling track data.
TransectProfileData	A container for data which fully describes a transect profile.
TransectProfileData.Config
TransectProfileDataBuilder	Builder for instances of TransectProfileData.
VectorDataMaskPersistenceConverter
VectorDataMaskPersistenceSpi
VectorDataNode	A container which allows to store vector data in the BEAM product model.
VirtualBand	A band contains the data for geophysical parameter in remote sensing data products.

Enum Summary

Enum	Description
GcpGeoCoding.Method	Class representing the approximation methods used for the GCP geo-coding.
GeneralFilterBand.OpType	Predefined operation types.
Graticule.TextLocation
ImageInfo.HistogramMatching	Enumerates the possible histogram matching modes.
ImageInfo.UncertaintyVisualisationMode	Enumerates the possible histogram matching modes.