Package uk.ac.rdg.resc.edal.feature

Class GridFeature

java.lang.Object

uk.ac.rdg.resc.edal.feature.AbstractDiscreteFeature<GeoPosition,GridCell4D>

uk.ac.rdg.resc.edal.feature.GridFeature

All Implemented Interfaces:

Serializable, DiscreteFeature<GeoPosition,GridCell4D>, Feature<GeoPosition>

public class GridFeature
extends AbstractDiscreteFeature<GeoPosition,GridCell4D>

An implementation of a Feature whose domain is a GridDomain

Author:

Guy

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
GridFeature(String id, String name, String description, GridDomain domain, Map<String,Parameter> parameters, Map<String,Array4D<Number>> valuesMap)

Method Summary

Modifier and Type	Method	Description
MapFeature	extractMapFeature(Set<String> varIds, RegularGrid targetGrid, Double elevation, org.joda.time.DateTime time)	Extracts a MapFeature from this GridFeature
GridDomain	getDomain()
Array4D<Number>	getValues(String paramId)	Gets the array of values for the given parameter.

Methods inherited from class uk.ac.rdg.resc.edal.feature.AbstractDiscreteFeature

getDescription, getFeatureProperties, getId, getName, getParameter, getParameterMap, getVariableIds

Methods inherited from class java.lang.Object

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

Constructor Detail

GridFeature

public GridFeature(String id,
                   String name,
                   String description,
                   GridDomain domain,
                   Map<String,Parameter> parameters,
                   Map<String,Array4D<Number>> valuesMap)

Method Detail

getValues

public Array4D<Number> getValues(String paramId)

Description copied from interface: DiscreteFeature

Gets the array of values for the given parameter. The shape of this array must match the shape of the array of domain objects (from DiscreteDomain.getDomainObjects()).

Specified by:

getValues in interface DiscreteFeature<GeoPosition,GridCell4D>

Overrides:

getValues in class AbstractDiscreteFeature<GeoPosition,GridCell4D>

Parameters:

paramId - The identifier from the Feature.getVariableIds() set of parameter IDs.

Returns:

the list of values for the requested member

getDomain

public GridDomain getDomain()

Description copied from interface: DiscreteFeature

Specified by:

getDomain in interface DiscreteFeature<GeoPosition,GridCell4D>

Specified by:

getDomain in interface Feature<GeoPosition>

Overrides:

getDomain in class AbstractDiscreteFeature<GeoPosition,GridCell4D>

Returns:

the domain of the values contained with the feature. May not return null

extractMapFeature

public MapFeature extractMapFeature(Set<String> varIds,
                                    RegularGrid targetGrid,
                                    Double elevation,
                                    org.joda.time.DateTime time)
                             throws DataReadingException

Extracts a MapFeature from this GridFeature

Parameters:

varIds - The variable IDs to extract. If null, all variables are extracted.

targetGrid - The desired RegularGrid of the resulting MapFeature

elevation - The elevation at which to extract data, can be null only if this GridFeature has no vertical domain

time - The time at which to extract data, can be null only if this GridFeature has no vertical domain

Returns:

The extracted MapFeature

Throws:

DataReadingException - If there is a problem reading the required data