Package org.esa.snap.core.datamodel
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 instances are composed as follows:
- Always one
MetadataElementnamed "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/longitudeTiePointGrids-
- geo-coding based on per-pixel latitude/longitude
invalid reference
org.esa.snap.core.datamodel.PixelGeoCodingBands -
- alternative geo-coding based on per-pixel latitude/longitude
invalid reference
org.esa.snap.core.datamodel.PixelGeoCoding2Bands (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 pointPlacemarksFXYGeoCoding- 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 theProductand its componentsFeatureUtils- Static utilities methods around theSimpleFeatureandGeometryused in conjunction withVectorDataNode
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.
-
ClassDescriptionThe
AbstractBandclass 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.AbstractGeoCodingis the base class of all geo-coding implementation.The base class forPlacemarkDescriptorimplementations.A band contains the data for geophysical parameter in remote sensing data products.Deprecated.Configuration which contains many key parameters with defaults and labels for the color manipulation toolTheColorPaletteDefclass represents a curve that is used to transform the sample values of a geo-physical band into color palette indexes.Contains all info for a color schemeA geo-coding based on a combination ofGeoCodings.Time coding which returns a constant value.A band that obtains its input data from an underlying source band and filters the raster data using aKernel.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.ADataNodeis the base class for all nodes within a data product which carry data.Creates an Densityplot from two given bands.Represents a band that generates its data by using another band as input and performs some kind of operation on this input.Provides the information required to decode integer sample values that are combined of single flags (bit indexes).A geo-coding based on equations.Ground control point (GCP) geo-coding.Class representing the approximation methods used for the GCP geo-coding.A band that obtains its input data from an underlying source raster and filters its data using a predefinedoperation type.Predefined operation types.Caution! This PersistenceConverter does not support historical dimap variations of GeneralFilterBand.Used as a fallback for the case that we can't find any suitablePlacemarkDescriptorfor a given SimpleFeatureType.Approximates the x(lat, lon) and y(lat, lon) functions.TheGeoCodinginterface provides geo-spatial latitude and longitude information for a given X/Y position of any (two-dimensional) raster.APlacemarkDescriptorthat is used to create placemarks that are actually plain geometries.TheGeoPosclass represents a geographical position measured in longitudes and latitudes.A geometric representation of a geographical grid measured in longitudes and latitudes.Utility class for the cumulative calculation of histograms from image data.This class contains information about how a product's raster data node is displayed as an image.Enumerates the possible histogram matching modes.Enumerates the possible histogram matching modes.TheImageLegendclass is used to generate an image legend from aImageInfoProvides the information required to decode integer sample values that represent index values (e.g.TheKernelclass 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.A time-coding based on an Array of modified julian days as double values.Deprecated.AMaskis used to mask image pixels of other raster data nodes.A mask image type which is based on band math.Specifies a factory for thesource imageused by aMask.A mask image type which is based on vector data.AMetadataAttributeis part of aMetadataElementAMetadataElementis a data node used to store metadata.APixelPosrepresents a position or point in a pixel coordinate system.A class for estimating the pixel position for a given geo-location.Placemarks are displayed as symbols at the image's pixel position corresponding to their geographical position.Placemark descriptors are used to describe and createPlacemarks.The interfacePointingwraps aGeoCodingand optionally provides more geometry information such as sun direction, satellite (view) direction and elevation at a given pixel position.A factory which creates instances of aPointingfor a given raster data node.Productinstances are an in-memory representation of a remote sensing data product.Deprecated.The abstractProductDataclass represents a generic data buffer used to hold the actual data values stored in remote sensing data products.TheProductData.ASCIIclass is aProductData.Bytespecialisation representing textual values.TheByteclass is aProductDataspecialisation for signed 8-bit integer fields.TheProductData.Floatclass is aProductDataspecialisation for 64-bit floating point fields.TheProductData.Floatclass is aProductDataspecialisation for 32-bit floating point fields.TheIntclass is aProductDataspecialisation for signed 32-bit integer fields.TheLongclass is aProductDataspecialisation for signed 64-bit integer fields.TheShortclass is aProductDataspecialisation for signed 16-bit integer fields.TheUByteclass is aProductDataspecialisation for unsigned 8-bit integer fields.TheUIntclass is aProductDataspecialisation for unsigned 32-bit integer fields.TheUShortclass is aProductDataspecialisation for unsigned 16-bit integer fields.TheProductData.UTCclass is aProductData.UIntspecialisation for UTC date/time values.A filter for products.A type-safe container for elements of the typeProduct.An event object passed into theProductManager.Listenermethods.A listener for the product manager.TheProductNodeis the base class for all nodes within a remote sensing data product and even the data product itself.A product node event informs a product change listener about the source of the notification.ProductNodeFilter<T extends ProductNode>A filter for abstract product nodes.ProductNodeGroup<T extends ProductNode>A type-safe container for elements of the typeProductNode.ProductNodeList<T extends ProductNode>A type-safe list for elements of the typeProductNode.A listener which listens to internal data product changes.A listener adapter which listens to product internal changes.A visitor for a product and all other product nodes.A default implementation of theProductVisitorinterface.TheProgressListenerinterface represents a listener for the observation of possibly time consuming processes.A utility class for clients interested in the progress made while reading, writing or somehow processing data products.TheRasterDataNodeclass ist the abstract base class for all objects in the product package that contain rasterized data.A raster data processor which is called for a set of raster lines to be processed.Class for approximating a function of two variables with a rational function.An interface for classes that resample a multi-size product to a single-size product.A profile used for the creation of RGB images.A profile used for the creation of RGB images.Class for rotating geographical positions.Provides the information required to decode integer sample values that are combined of single flags (bit indexes).The scaling method used for geophysical value transformation in aBand.Represents a geo-coded scene.This class is not public API yet.Provides various transformations from localRasterDataNodecoordinate reference systems to aProduct's scene coordinate reference systems.Provides statistic information for a raster data node at a given image resolution level.The factory forStxinstances.Utility class for calculating minimum, maximum, mean and standard deviation.Deprecated.since SNAP 8.0.0, Better useComponentGeoCodingwithTiePointInverseand one ofTiePointInverse,TiePointBilinearForwardandTiePointSplineForwardA tie-point grid contains the data for geophysical parameter in remote sensing data products.APointingwhich uses tie-point grids to compute the geometry for a given pixel position.TheTimeCodinginterface allows to convert pixel coordinates to time values and vice versa (if possible).Placemark descriptor implementation for handling track data.A container for data which fully describes a transect profile.Builder for instances ofTransectProfileData.A container which allows to store vector data in the BEAM product model.A band contains the data for geophysical parameter in remote sensing data products.
CrsGeoCodinginstead.