Module org.opengis.geoapi

Package org.opengis.referencing.operation

Interface PassThroughOperation

All Superinterfaces:

CoordinateOperation, IdentifiedObject, SingleOperation

@UML(identifier="PassThroughOperation",
     specification=ISO_19111)
public interface PassThroughOperation
extends SingleOperation

An operation specifying a subset of a coordinate tuple subjected to a specific coordinate operation. Coordinates in the coordinate tuple other than the subset remain unchanged. For example, it may be required to transform only the horizontal or only the vertical component of a compound three-dimensional coordinate reference system (CRS). This operation specifies what subset of a coordinate tuple is subject to a requested operation. It takes the form of referencing another coordinate operation and specifying a sequence of numbers defining the positions in the coordinate tuple of the coordinates affected by that operation. The order of the coordinates in a coordinate tuple shall agree with the order of the coordinate system axes as defined for the associated coordinate system.

Upcoming API change
This interface is conformant to ISO 19111:2003. But the ISO 19111:2007 revision changed the parent interface from SingleOperation to CoordinateOperation. This change may be applied in GeoAPI 4.0.

Since:

1.0

Field Summary

Fields inherited from interface org.opengis.referencing.operation.CoordinateOperation

COORDINATE_OPERATION_ACCURACY_KEY, DOMAIN_OF_VALIDITY_KEY, OPERATION_VERSION_KEY, SCOPE_KEY

Fields inherited from interface org.opengis.referencing.IdentifiedObject

ALIAS_KEY, DOMAINS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Method Summary

Modifier and Type	Method	Description
default Collection<PositionalAccuracy>	getCoordinateOperationAccuracy()	Returns estimate(s) of the impact of this operation on point accuracy.
default Collection<ObjectDomain>	getDomains()	Returns the usage of this CRS-related object.
default Optional<CoordinateReferenceSystem>	getInterpolationCRS()	Returns the CRS to be used for interpolations in a grid.
int[]	getModifiedCoordinates()	Returns the positions in a source coordinate tuple of the coordinates affected by this pass-through operation.
SingleOperation	getOperation()	Returns the operation to apply on the subset of a coordinate tuple.
default Optional<Temporal>	getSourceEpoch()	Returns the date at which source coordinate tuples are valid.
default Optional<Temporal>	getTargetEpoch()	Returns the date at which target coordinate tuples are valid.

Methods inherited from interface org.opengis.referencing.operation.CoordinateOperation

getDomainOfValidity, getMathTransform, getOperationVersion, getScope, getSourceCRS, getTargetCRS, transform

Methods inherited from interface org.opengis.referencing.IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Methods inherited from interface org.opengis.referencing.operation.SingleOperation

getMethod, getParameterValues

Method Details

getOperation

@UML(identifier="coordOperation",
     obligation=MANDATORY,
     specification=ISO_19111)
SingleOperation getOperation()

Returns the operation to apply on the subset of a coordinate tuple.

Upcoming API change
This method is conformant to ISO 19111:2003. But the ISO 19111:2007 revision changed the type from SingleOperation to CoordinateOperation. This change may be applied in GeoAPI 4.0. This is necessary for supporting usage of PassThroughOperation with ConcatenatedOperation.

Returns:

the operation to apply on the subset of a coordinate tuple.

getModifiedCoordinates

@UML(identifier="modifiedCoordinate",
     obligation=MANDATORY,
     specification=ISO_19111)
int[] getModifiedCoordinates()

Returns the positions in a source coordinate tuple of the coordinates affected by this pass-through operation. Values 0 identifies the first source coordinate, value 1 identifies the second source coordinate, etc. This is an ordered sequence: coordinates will be given to the operation in the same order as the indices returned by this method.

Returns:

zero-based indices of the modified source coordinates.

getInterpolationCRS

@UML(identifier="interpolationCRS",
     obligation=OPTIONAL,
     specification=ISO_19111)
default Optional<CoordinateReferenceSystem> getInterpolationCRS()

Returns the CRS to be used for interpolations in a grid. By default, this is the interpolation CRS of the operation.

Specified by:

getInterpolationCRS in interface CoordinateOperation

Returns:

the CRS to be used for interpolations in a grid.

Since:

3.1

getSourceEpoch

@UML(identifier="sourceCoordinateEpoch",
     obligation=CONDITIONAL,
     specification=ISO_19111)
default Optional<Temporal> getSourceEpoch()

Returns the date at which source coordinate tuples are valid. By default, this is the source epoch of the operation.

Specified by:

getSourceEpoch in interface CoordinateOperation

Returns:

epoch at which source coordinate tuples are valid.

Since:

3.1

See Also:

• CoordinateOperation.getSourceCRS()
• DynamicReferenceFrame.getFrameReferenceEpoch()

getTargetEpoch

@UML(identifier="targetCoordinateEpoch",
     obligation=CONDITIONAL,
     specification=ISO_19111)
default Optional<Temporal> getTargetEpoch()

Returns the date at which target coordinate tuples are valid. By default, this is the target epoch of the operation.

Specified by:

getTargetEpoch in interface CoordinateOperation

Returns:

epoch at which target coordinate tuples are valid.

Since:

3.1

See Also:

• CoordinateOperation.getTargetCRS()
• DynamicReferenceFrame.getFrameReferenceEpoch()

getDomains

@UML(identifier="ObjectUsage.domain",
     obligation=OPTIONAL,
     specification=ISO_19111)
default Collection<ObjectDomain> getDomains()

Returns the usage of this CRS-related object. By default, this is the domain of the operation.

Specified by:

getDomains in interface IdentifiedObject

Returns:

scopes and domains of validity of this object.

Since:

3.1

getCoordinateOperationAccuracy

@UML(identifier="coordinateOperationAccuracy",
     obligation=OPTIONAL,
     specification=ISO_19111)
default Collection<PositionalAccuracy> getCoordinateOperationAccuracy()

Returns estimate(s) of the impact of this operation on point accuracy. By default, this is the accuracy of the operation.

Specified by:

getCoordinateOperationAccuracy in interface CoordinateOperation

Returns:

the position error estimates, or an empty collection if not available.