public abstract class CuboidCoverage extends Object implements Coverage
Factory methods are provided for concrete instances of this class.
Modifier and Type | Class and Description |
---|---|
static interface |
CuboidCoverage.ErrorDecoder
Defines mapping of tuple to error value.
|
static interface |
CuboidCoverage.PointDecoder
Defines mapping of tuple to Cartesian position.
|
Modifier | Constructor and Description |
---|---|
protected |
CuboidCoverage(int ndim)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
String |
coverageText()
Provides a short, human-readable indication of the coverage.
|
static CuboidCoverage.PointDecoder |
createCartesianPointDecoder(int ndim)
Returns a PointDecoder for simple Cartesian tuples.
|
static CuboidCoverage |
createFixedCartesianCoverage(int ndim,
double err)
Creates a coverage suitable for a fixed isotropic match error
in an N-dimensional Cartesian space,
where tuples are simple N-dimensional coordinate vectors.
|
static CuboidCoverage |
createFixedCartesianCoverage(int ndim,
double[] errs)
Creates a coverage suitable for a fixed anisotropic match error
in an N-dimensional Cartesian space,
where tuples are simple N-dimensional coordinate vectors.
|
static CuboidCoverage |
createFixedErrorCoverage(int ndim,
double[] errors,
CuboidCoverage.PointDecoder pointDecoder)
Creates a coverage suitable for a fixed anisotropic match error
in an N-dimensional coordinate space,
with custom tuple->coordinate mapping.
|
static CuboidCoverage |
createVariableErrorCoverage(int ndim,
CuboidCoverage.PointDecoder pointDecoder,
CuboidCoverage.ErrorDecoder errorDecoder)
Creates a coverage suitable for variable isotropic match errors
in an N-dimensional coordinate space.
|
void |
intersection(Coverage other)
Narrows this coverage object to contain only the intersection of
its current state and the supplied coverage.
|
boolean |
isEmpty()
Returns true if the coverage represents the empty set.
|
void |
union(Coverage other)
Modifies the state of this coverage object as if all the tuples
fed to the other had been fed to this one as well as its current
contents.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createTestFactory, extend
protected CuboidCoverage(int ndim)
ndim
- dimensionality of regionpublic boolean isEmpty()
Coverage
isEmpty
in interface Coverage
Coverage.createTestFactory()
test
is guaranteed to return falsepublic void union(Coverage other)
Coverage
public void intersection(Coverage other)
Coverage
intersection
in interface Coverage
other
- different coverage object of a type
assumed compatible with this objectpublic String coverageText()
Coverage
coverageText
in interface Coverage
public static CuboidCoverage createFixedCartesianCoverage(int ndim, double err)
ndim
- dimensionalityerr
- maximum separation for matchpublic static CuboidCoverage createFixedCartesianCoverage(int ndim, double[] errs)
ndim
- dimensionalityerrs
- ndim-dimensional array giving maximum separations along
each axispublic static CuboidCoverage createFixedErrorCoverage(int ndim, double[] errors, CuboidCoverage.PointDecoder pointDecoder)
ndim
- dimensionality of Cartesian spaceerrors
- ndim-dimensional array giving maximum separations along
each axispointDecoder
- thread-safe converter of tuples into
N-dimensional Cartesian position vectorspublic static CuboidCoverage createVariableErrorCoverage(int ndim, CuboidCoverage.PointDecoder pointDecoder, CuboidCoverage.ErrorDecoder errorDecoder)
ndim
- dimensionality of Cartesian spacepointDecoder
- thread-safe converter of tuples into
N-dimensional Cartesian position vectorserrorDecoder
- thread-safe extractor of isotropic maximum
match separation from tuplespublic static CuboidCoverage.PointDecoder createCartesianPointDecoder(int ndim)
ndim
- dimensionality of tuples and output vectorsCopyright © 2024 Central Laboratory of the Research Councils. All Rights Reserved.