Package org.ivoa.dm.caom2

Class Position.PositionBuilder

java.lang.Object

org.ivoa.dm.caom2.Position.PositionBuilder

Enclosing class:

Position

public static class Position.PositionBuilder
extends Object

A builder class for Position, mainly for use in the functional builder pattern.

Field Summary

Fields

Modifier and Type	Field	Description
Shape	bounds	spatial boundary that includes the data (CHANGED cardinality in CAOM-2.5).
CalibrationStatus	calibration	term describing the calibration of the position axis values (NEW in CAOM-2.5).
Dimension2D	dimension	number of separate measurements (pixels) along each axis.
Interval	maxRecoverableScale	maximum size of spatial structure (signal) that can be recovered or seen in the data (new in CAOM-2.5).
Shape	minBounds	minimum spatial boundary that includes the data; this value is smaller than the bounds (maximum) when the field-of-view varies because it is dependent on another axis (usually energy) (new in CAOM-2.5).
Double	resolution	mean spatial resolution (full-width-half-max) per pixel.
Interval	resolutionBounds	range of resolution within the bounds.
MultiShape	samples	detailed sub-samples of the bounds (CHANGED in CAOM-2.5).
Double	sampleSize	median pixel size.

Constructor Summary

Constructors

Constructor	Description
PositionBuilder()

Method Summary

Modifier and Type	Method	Description
Position	create()	create a Position from this builder.

Methods inherited from class java.lang.Object

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

Field Details

bounds

public Shape bounds

spatial boundary that includes the data (CHANGED cardinality in CAOM-2.5).

samples

public MultiShape samples

detailed sub-samples of the bounds (CHANGED in CAOM-2.5).

minBounds

public Shape minBounds

minimum spatial boundary that includes the data; this value is smaller than the bounds (maximum) when the field-of-view varies because it is dependent on another axis (usually energy) (new in CAOM-2.5).

dimension

public Dimension2D dimension

number of separate measurements (pixels) along each axis.

maxRecoverableScale

public Interval maxRecoverableScale

maximum size of spatial structure (signal) that can be recovered or seen in the data (new in CAOM-2.5).

resolution

public Double resolution

mean spatial resolution (full-width-half-max) per pixel.

resolutionBounds

public Interval resolutionBounds

range of resolution within the bounds.

sampleSize

public Double sampleSize

median pixel size.

calibration

public CalibrationStatus calibration

term describing the calibration of the position axis values (NEW in CAOM-2.5).

Constructor Details

PositionBuilder

public PositionBuilder()

Method Details

create

public Position create()

create a Position from this builder.

Returns:

an object initialized from the builder.