public static class SimpleStereoPair.Builder
extends java.lang.Object
To use the builder, instantiate it with the two observations, optionally set
a label and/or comment, and invoke the build()
method. For example,
to create a new simple stereo pair from the observations obs1 and
obs2 (both of a Target
called aramChaos), use the
following code:
SimpleStereoPair pair = new SimpleStereoPair.Builder ( obs1, obs2 ).label ("Aram Chaos Pair").comment ("Candidate pair of Aram Chaos").build ();
The two observations must be of the same target site or an IllegalArgumentException
will be thrown.
Constructor and Description |
---|
Builder(Observation stereo1,
Observation stereo2)
Creates a new simple stereo pair builder with the indicated observations.
|
Modifier and Type | Method and Description |
---|---|
SimpleStereoPair |
build()
Instantiates a new, immutable simple stereo pair from this builder.
|
SimpleStereoPair.Builder |
comment(java.lang.String comment)
Sets the optional comment for this builder.
|
SimpleStereoPair.Builder |
label(java.lang.String label)
Sets the optional label for this builder.
|
public Builder(Observation stereo1, Observation stereo2)
stereo1
- the stereo-1 observation.stereo2
- the stereo-2 observation.java.lang.NullPointerException
- if either of the observations is
null.java.lang.IllegalArgumentException
- if the two observations are not of the
same target site.public SimpleStereoPair.Builder label(java.lang.String label)
build()
method is invoked.label
- the stereo pair's optional label.public SimpleStereoPair.Builder comment(java.lang.String comment)
build()
method is invoked.comment
- the stereo pair's optional comment.public SimpleStereoPair build()
Copyright \ (C) Arizona Board of Regents on behalf of the \ Planetary Image Research Laboratory, Lunar and \ Planetary Laboratory at the University of Arizona