org.geotools.gce.imagemosaic

Class Utils

Object

Utils

public class Utils
extends Object

Sparse utilities for the various mosaic classes. I use them to extract complex code from other places.

Author:

Simone Giannecchini, GeoSolutions S.A.S.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Utils.BBOXFilterExtractor Extracts a bbox from a filter in case there is at least one.
static class	Utils.Prop
static class	Utils.SourceGetter Given a source object, allow to retrieve (when possible) the related url, the related file or the original input source object itself.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADDITIONAL_DOMAIN
static Hints.Key	AUXILIARY_DATASTORE_PATH
static Hints.Key	AUXILIARY_FILES_PATH
static String	BBOX
static Hints.Key	CHECK_AUXILIARY_METADATA
static Hints.Key	COG_SETTINGS
static String	CRS_DOMAIN
static String	DATASTORE_PROPERTIES
static boolean	DEFAULT_COLOR_EXPANSION_BEHAVIOR
static boolean	DEFAULT_CONFIGURATION_CACHING
static boolean	DEFAULT_FOOTPRINT_MANAGEMENT
static String	DEFAULT_INDEX_NAME
static String	DEFAULT_LOCATION_ATTRIBUTE Default location attribute name.
static boolean	DEFAULT_PATH_BEHAVIOR Default path behavior with respect to absolute paths.
static int	DEFAULT_PRIORITY Default priority for the underlying Thread.
static String	DEFAULT_RANGE_READER
static boolean	DEFAULT_RECURSION_BEHAVIOR
static String	DEFAULT_WILCARD Default wildcard for creating mosaics.
static String	ELEVATION_DOMAIN
static Hints.Key	EXCLUDE_MOSAIC
static Hints	EXCLUDE_MOSAIC_HINTS Hints to use for avoiding to search for the imagemosaic format
static FilterFactory2	FF
static Set<String>	LOG_EXCLUDES
static Hints.Key	MOSAIC_READER
static ObjectFactory	OBJECT_FACTORY
static String	PAM_DATASET Deprecated.
static Hints.Key	PARENT_DIR
static String	PROPERTIES_SEPARATOR
static String	RANGE_SPLITTER_CHAR
static String	RESOLUTION_DOMAIN
static String	RESOLUTION_X_DOMAIN
static String	RESOLUTION_Y_DOMAIN
static double[][]	RGB_TO_GRAY_MATRIX RGB to GRAY coefficients (for Luminance computation)
static String	SAMPLE_IMAGE_NAME
static String	SAMPLE_IMAGE_NAME_LEGACY
static DataStoreFactorySpi	SHAPE_SPI
static String	TIME_DOMAIN
static TimeZone	UTC_TIME_ZONE

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static boolean	checkColorModels(ColorModel defaultCM, byte[][] defaultPalette, ColorModel actualCM) This method checks the ColorModel of the current image with the one of the first image in order to check if they are compatible or not in order to perform a mosaic operation.
static String	checkDirectory(String testingDirectory, boolean writable)
static boolean	checkFileReadable(File file) Checks that a File is a real file, exists and is readable.
static Map<String,Serializable>	createDataStoreParamsFromPropertiesFile(Properties properties, DataStoreFactorySpi spi)
static Map<String,Serializable>	createDataStoreParamsFromPropertiesFile(URL datastoreProperties)
static Range<? extends Number>	createRange(Object firstValue, Object secondValue) Create a Range of numbers from a couple of values.
static Geometry	decimate(Geometry geometry) Decimate a geometry (reducing the number of vertices) for incoming buffering
static IOFileFilter	excludeFilters(IOFileFilter inputFilter, IOFileFilter... filters)
static byte[][]	extractPalette(IndexColorModel indexColorModel) Extract the palette from an IndexColorModel.
static Map<String,Serializable>	filterDataStoreParams(Properties properties, DataStoreFactorySpi spi)
static void	fixH2DatabaseLocation(Map<String,Serializable> params, String parentLocation)
static void	fixH2MVCCParam(Map<String,Serializable> params)
static void	fixPostgisDBCreationParams(Map<String,Serializable> datastoreParams)
static Object	getAttribute(SimpleFeature feature, String attribute)
static BorderExtender	getBorderExtenderHint(RenderingHints renderHints)
static IOFileFilter	getCleanupFilter()
static File	getFile(String strValue, File rootFolder) Returns the File associated to the rootFolder if not absolute
static String	getFileInfo(File file) Creates a human readable message that describe the provided File object in terms of its properties.
static Object	getHintIfAvailable(RenderingHints hints, RenderingHints.Key key)
static Histogram	getHistogram(String file) Setup a Histogram object by deserializing a file representing a serialized Histogram.
static ImageLayout	getImageLayoutHint(RenderingHints renderHints)
static String	getIndexerProperty(String locationPath, String propertyName)
static ImageInputStreamSpi	getInputStreamSPIFromURL(URL granuleUrl)
static String	getMessageFromException(Exception exception)
static ImageReaderSpi	getReaderSpiFromStream(ImageReaderSpi suggestedSPI, ImageInputStream inStream)
static TileCache	getTileCacheHint(RenderingHints renderHints)
static TileScheduler	getTileSchedulerHint(RenderingHints renderHints)
static boolean	homogeneousCheck(int numberOfLevels, double[][] resolutionLevels, double[][] compareLevels) Check whether 2 resolution levels sets are homogeneous (within a tolerance)
static boolean	isH2Store(DataStoreFactorySpi spi)
static boolean	isOracleStore(DataStoreFactorySpi spi) Checks if the provided factory spi builds a Oracle store
static boolean	isPostgisStore(DataStoreFactorySpi spi) Checks if the provided factory spi builds a Postgis store
static boolean	isSQLServerStore(DataStoreFactorySpi spi) Checks if the provided factory spi builds a SQLServer store
static boolean	isSupportedCRS(GridCoverage2DReader reader, CoordinateReferenceSystem crs) Check if the provided reader is a MultiCRS Reader and it can support the specified crs.
static boolean	isValidMosaicSchema(SimpleFeatureType schema, String locationAttributeName) Returns true if the type is usable as a mosaic index
static RenderedImage	loadSampleImage(File sampleImageFile) Load a sample image from which we can take the sample model and color model to be used to fill holes in responses.
static void	marshal(Indexer indexer, File indexerFile) Marshals the Indexer object to the specified file
static PAMDataset	mergePamDatasets(PAMDataset[] pamDatasets) Merge statistics across datasets.
static boolean	minimalIndexCheck(Object source) Simple minimal check which checks whether and indexer file exists
static ReferencedEnvelope	parseEnvelope(String bboxString) Parses a bbox in the form of MIX,MINY MAXX,MAXY
static ReferencedEnvelope	reprojectEnvelope(ReferencedEnvelope sourceEnvelope, CoordinateReferenceSystem targetCRS, ReferencedEnvelope targetReferenceEnvelope)
static Geometry	reprojectEnvelopeToGeometry(ReferencedEnvelope sourceEnvelope, CoordinateReferenceSystem targetCRS, ReferencedEnvelope targetReferenceEnvelope) Reprojects an envelope using the ProjectionHandler machinery.
static ROI	roiIntersect(ROI roi, ROIGeometry roiGeometry, RenderingHints hints) Intersects a ROI with a ROI geometry, with fallback on GeometrySnapper if a TopologyException occurs
static Hints	setupJAIHints(RenderingHints inputHints)
static void	storeSampleImage(File sampleImageFile, SampleModel defaultSM, ColorModel defaultCM) Store a sample image from which we can derive the default SM and CM
static Indexer	unmarshal(File indexerFile) Unmarshal the file and return and Indexer object.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FF

public static final FilterFactory2 FF

DEFAULT_RANGE_READER

public static final String DEFAULT_RANGE_READER

See Also:

Constant Field Values

EXCLUDE_MOSAIC

public static final Hints.Key EXCLUDE_MOSAIC

EXCLUDE_MOSAIC_HINTS

public static final Hints EXCLUDE_MOSAIC_HINTS

Hints to use for avoiding to search for the imagemosaic format

CHECK_AUXILIARY_METADATA

public static final Hints.Key CHECK_AUXILIARY_METADATA

COG_SETTINGS

public static final Hints.Key COG_SETTINGS

AUXILIARY_FILES_PATH

public static final Hints.Key AUXILIARY_FILES_PATH

AUXILIARY_DATASTORE_PATH

public static final Hints.Key AUXILIARY_DATASTORE_PATH

PARENT_DIR

public static final Hints.Key PARENT_DIR

MOSAIC_READER

public static final Hints.Key MOSAIC_READER

RANGE_SPLITTER_CHAR

public static final String RANGE_SPLITTER_CHAR

See Also:

Constant Field Values

PAM_DATASET

@Deprecated
public static final String PAM_DATASET

Deprecated.

See Also:

Constant Field Values

DATASTORE_PROPERTIES

public static final String DATASTORE_PROPERTIES

See Also:

Constant Field Values

PROPERTIES_SEPARATOR

public static final String PROPERTIES_SEPARATOR

See Also:

Constant Field Values

LOG_EXCLUDES

public static final Set<String> LOG_EXCLUDES

RGB_TO_GRAY_MATRIX

public static final double[][] RGB_TO_GRAY_MATRIX

RGB to GRAY coefficients (for Luminance computation)

DEFAULT_WILCARD

public static final String DEFAULT_WILCARD

Default wildcard for creating mosaics.

See Also:

Constant Field Values

DEFAULT_PATH_BEHAVIOR

public static final boolean DEFAULT_PATH_BEHAVIOR

Default path behavior with respect to absolute paths.

See Also:

Constant Field Values

DEFAULT_PRIORITY

public static final int DEFAULT_PRIORITY

Default priority for the underlying Thread.

See Also:

Constant Field Values

DEFAULT_LOCATION_ATTRIBUTE

public static final String DEFAULT_LOCATION_ATTRIBUTE

Default location attribute name.

See Also:

Constant Field Values

DEFAULT_INDEX_NAME

public static final String DEFAULT_INDEX_NAME

See Also:

Constant Field Values

SHAPE_SPI

public static final DataStoreFactorySpi SHAPE_SPI

DEFAULT_RECURSION_BEHAVIOR

public static final boolean DEFAULT_RECURSION_BEHAVIOR

See Also:

Constant Field Values

DEFAULT_FOOTPRINT_MANAGEMENT

public static final boolean DEFAULT_FOOTPRINT_MANAGEMENT

See Also:

Constant Field Values

DEFAULT_CONFIGURATION_CACHING

public static final boolean DEFAULT_CONFIGURATION_CACHING

See Also:

Constant Field Values

DEFAULT_COLOR_EXPANSION_BEHAVIOR

public static final boolean DEFAULT_COLOR_EXPANSION_BEHAVIOR

See Also:

Constant Field Values

UTC_TIME_ZONE

public static final TimeZone UTC_TIME_ZONE

SAMPLE_IMAGE_NAME_LEGACY

public static final String SAMPLE_IMAGE_NAME_LEGACY

See Also:

Constant Field Values

SAMPLE_IMAGE_NAME

public static final String SAMPLE_IMAGE_NAME

See Also:

Constant Field Values

BBOX

public static final String BBOX

See Also:

Constant Field Values

TIME_DOMAIN

public static final String TIME_DOMAIN

See Also:

Constant Field Values

ELEVATION_DOMAIN

public static final String ELEVATION_DOMAIN

See Also:

Constant Field Values

CRS_DOMAIN

public static final String CRS_DOMAIN

See Also:

Constant Field Values

RESOLUTION_DOMAIN

public static final String RESOLUTION_DOMAIN

See Also:

Constant Field Values

RESOLUTION_X_DOMAIN

public static final String RESOLUTION_X_DOMAIN

See Also:

Constant Field Values

RESOLUTION_Y_DOMAIN

public static final String RESOLUTION_Y_DOMAIN

See Also:

Constant Field Values

ADDITIONAL_DOMAIN

public static final String ADDITIONAL_DOMAIN

See Also:

Constant Field Values

OBJECT_FACTORY

public static ObjectFactory OBJECT_FACTORY

Constructor Detail

Utils

public Utils()

Method Detail

isSupportedCRS

public static boolean isSupportedCRS(GridCoverage2DReader reader,
                                     CoordinateReferenceSystem crs)
                              throws FactoryException,
                                     IOException

Check if the provided reader is a MultiCRS Reader and it can support the specified crs.

Throws:

FactoryException

IOException

getAttribute

public static Object getAttribute(SimpleFeature feature,
                                  String attribute)

getMessageFromException

public static String getMessageFromException(Exception exception)

parseEnvelope

public static ReferencedEnvelope parseEnvelope(String bboxString)

Parses a bbox in the form of MIX,MINY MAXX,MAXY

Parameters:

bboxString - the string to parse the bbox from

Returns:

a ReferencedEnvelope with the parse bbox or null

excludeFilters

public static IOFileFilter excludeFilters(IOFileFilter inputFilter,
                                          IOFileFilter... filters)

checkFileReadable

public static boolean checkFileReadable(File file)

Checks that a File is a real file, exists and is readable.

Parameters:

file - the File instance to check. Must not be null.

Returns:

true in case the file is a real file, exists and is readable; false otherwise.

getFileInfo

public static String getFileInfo(File file)

Creates a human readable message that describe the provided File object in terms of its properties.

Useful for creating meaningful log messages.

Parameters:

file - the File object to create a descriptive message for

Returns:

a String containing a descriptive message about the provided File.

checkDirectory

public static String checkDirectory(String testingDirectory,
                                    boolean writable)
                             throws IllegalArgumentException

Throws:

IllegalArgumentException

createDataStoreParamsFromPropertiesFile

public static Map<String,Serializable> createDataStoreParamsFromPropertiesFile(URL datastoreProperties)
                                                                        throws IOException

Throws:

IOException

storeSampleImage

public static void storeSampleImage(File sampleImageFile,
                                    SampleModel defaultSM,
                                    ColorModel defaultCM)
                             throws IOException

Store a sample image from which we can derive the default SM and CM

Parameters:

sampleImageFile - where we should store the image

defaultSM - the SampleModel for the sample image.

defaultCM - the ColorModel for the sample image.

Throws:

IOException - in case something bad occurs during writing.

loadSampleImage

public static RenderedImage loadSampleImage(File sampleImageFile)

Load a sample image from which we can take the sample model and color model to be used to fill holes in responses.

Parameters:

sampleImageFile - the path to sample image.

Returns:

a sample image from which we can take the sample model and color model to be used to fill holes in responses.

createDataStoreParamsFromPropertiesFile

public static Map<String,Serializable> createDataStoreParamsFromPropertiesFile(Properties properties,
                                                                               DataStoreFactorySpi spi)
                                                                        throws IOException

Throws:

IOException

filterDataStoreParams

public static Map<String,Serializable> filterDataStoreParams(Properties properties,
                                                             DataStoreFactorySpi spi)
                                                      throws IOException

Throws:

IOException

getIndexerProperty

public static String getIndexerProperty(String locationPath,
                                        String propertyName)

getHistogram

public static Histogram getHistogram(String file)

Setup a Histogram object by deserializing a file representing a serialized Histogram.

Returns:

the deserialized histogram.

getImageLayoutHint

public static ImageLayout getImageLayoutHint(RenderingHints renderHints)

getTileCacheHint

public static TileCache getTileCacheHint(RenderingHints renderHints)

getBorderExtenderHint

public static BorderExtender getBorderExtenderHint(RenderingHints renderHints)

getTileSchedulerHint

public static TileScheduler getTileSchedulerHint(RenderingHints renderHints)

getHintIfAvailable

public static Object getHintIfAvailable(RenderingHints hints,
                                        RenderingHints.Key key)

setupJAIHints

public static Hints setupJAIHints(RenderingHints inputHints)

createRange

public static Range<? extends Number> createRange(Object firstValue,
                                                  Object secondValue)

Create a Range of numbers from a couple of values.

minimalIndexCheck

public static boolean minimalIndexCheck(Object source)

Simple minimal check which checks whether and indexer file exists

homogeneousCheck

public static boolean homogeneousCheck(int numberOfLevels,
                                       double[][] resolutionLevels,
                                       double[][] compareLevels)

Check whether 2 resolution levels sets are homogeneous (within a tolerance)

unmarshal

public static Indexer unmarshal(File indexerFile)
                         throws JAXBException

Unmarshal the file and return and Indexer object.

Throws:

JAXBException

marshal

public static void marshal(Indexer indexer,
                           File indexerFile)
                    throws JAXBException

Marshals the Indexer object to the specified file

Throws:

JAXBException

checkColorModels

public static boolean checkColorModels(ColorModel defaultCM,
                                       byte[][] defaultPalette,
                                       ColorModel actualCM)

This method checks the ColorModel of the current image with the one of the first image in order to check if they are compatible or not in order to perform a mosaic operation.

It is worth to point out that we also check if, in case we have two index color model image, we also try to suggest whether or not we should do a color expansion.

Returns:

a boolean asking to skip this feature.

isH2Store

public static boolean isH2Store(DataStoreFactorySpi spi)

fixH2DatabaseLocation

public static void fixH2DatabaseLocation(Map<String,Serializable> params,
                                         String parentLocation)
                                  throws MalformedURLException

Throws:

MalformedURLException

isOracleStore

public static boolean isOracleStore(DataStoreFactorySpi spi)

Checks if the provided factory spi builds a Oracle store

isPostgisStore

public static boolean isPostgisStore(DataStoreFactorySpi spi)

Checks if the provided factory spi builds a Postgis store

isSQLServerStore

public static boolean isSQLServerStore(DataStoreFactorySpi spi)

Checks if the provided factory spi builds a SQLServer store

mergePamDatasets

public static PAMDataset mergePamDatasets(PAMDataset[] pamDatasets)

Merge statistics across datasets.

getCleanupFilter

public static IOFileFilter getCleanupFilter()

fixH2MVCCParam

public static void fixH2MVCCParam(Map<String,Serializable> params)

fixPostgisDBCreationParams

public static void fixPostgisDBCreationParams(Map<String,Serializable> datastoreParams)

getReaderSpiFromStream

public static ImageReaderSpi getReaderSpiFromStream(ImageReaderSpi suggestedSPI,
                                                    ImageInputStream inStream)
                                             throws IOException

Throws:

IOException

getInputStreamSPIFromURL

public static ImageInputStreamSpi getInputStreamSPIFromURL(URL granuleUrl)
                                                    throws IOException

Throws:

IOException

extractPalette

public static byte[][] extractPalette(IndexColorModel indexColorModel)

Extract the palette from an IndexColorModel.

isValidMosaicSchema

public static boolean isValidMosaicSchema(SimpleFeatureType schema,
                                          String locationAttributeName)

Returns true if the type is usable as a mosaic index

reprojectEnvelope

public static ReferencedEnvelope reprojectEnvelope(ReferencedEnvelope sourceEnvelope,
                                                   CoordinateReferenceSystem targetCRS,
                                                   ReferencedEnvelope targetReferenceEnvelope)
                                            throws FactoryException,
                                                   TransformException

Throws:

FactoryException

TransformException

reprojectEnvelopeToGeometry

public static Geometry reprojectEnvelopeToGeometry(ReferencedEnvelope sourceEnvelope,
                                                   CoordinateReferenceSystem targetCRS,
                                                   ReferencedEnvelope targetReferenceEnvelope)
                                            throws FactoryException,
                                                   TransformException

Reprojects an envelope using the ProjectionHandler machinery. The output can be a multipolygon in case of wrapping, which might or might not be what you want, act accordingly

Throws:

FactoryException

TransformException

getFile

public static File getFile(String strValue,
                           File rootFolder)
                    throws IOException

Returns the File associated to the rootFolder if not absolute

Throws:

IOException

decimate

public static Geometry decimate(Geometry geometry)

Decimate a geometry (reducing the number of vertices) for incoming buffering

roiIntersect

public static ROI roiIntersect(ROI roi,
                               ROIGeometry roiGeometry,
                               RenderingHints hints)

Intersects a ROI with a ROI geometry, with fallback on GeometrySnapper if a TopologyException occurs