Package org.ivoa.dm.caom2

Class Energy.EnergyBuilder

java.lang.Object

org.ivoa.dm.caom2.Energy.EnergyBuilder

Enclosing class:

Energy

public static class Energy.EnergyBuilder
extends Object

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

Field Summary

Fields

Modifier and Type	Field	Description
List<String>	bandpassName	telescope- and instrument-specific name for the energy band(s) included; multiple bands may be included if energies from all specified bands are included in the data (in the sense of union).
Interval	bounds	simple outer bounds of energy coverage of the data (CHANGED cardinality in CAOM-2.5).
CalibrationStatus	calibration	term describing the calibration of the energy axis values (new in CAOM-2.5).
Integer	dimension	number of measurements (pixels) on the energy axis.
List<EnergyBand>	energyBands	standard name of the energy regime(s) included in the data.
Double	resolution	mean absolute spectral resolution per pixel (new in CAOM-2.5).
Interval	resolutionBounds	range of absolute spectral resolution within the bounds (new in CAOM-2.5).
Double	resolvingPower	mean spectral resolving power per pixel (relative resolution).
Interval	resolvingPowerBounds	range of resolving power within the bounds (relative resolution).
Double	restwav	rest energy of the target energy transition (name changed in CAOM-2.5).
List<IntervalM>	samples	detailed energy coverage of the data (CHANGED in CAOM-2.5).
Double	sampleSize	mean pixel size.
EnergyTransition	transition	target energy transition for this data.

Constructor Summary

Constructors

Constructor	Description
EnergyBuilder()

Method Summary

Modifier and Type	Method	Description
Energy	create()	create a Energy 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 Interval bounds

simple outer bounds of energy coverage of the data (CHANGED cardinality in CAOM-2.5).

samples

public List<IntervalM> samples

detailed energy coverage of the data (CHANGED in CAOM-2.5).

energyBands

public List<EnergyBand> energyBands

standard name of the energy regime(s) included in the data.

dimension

public Integer dimension

number of measurements (pixels) on the energy axis.

resolvingPower

public Double resolvingPower

mean spectral resolving power per pixel (relative resolution).

resolvingPowerBounds

public Interval resolvingPowerBounds

range of resolving power within the bounds (relative resolution).

resolution

public Double resolution

mean absolute spectral resolution per pixel (new in CAOM-2.5).

resolutionBounds

public Interval resolutionBounds

range of absolute spectral resolution within the bounds (new in CAOM-2.5).

sampleSize

public Double sampleSize

mean pixel size.

bandpassName

public List<String> bandpassName

telescope- and instrument-specific name for the energy band(s) included; multiple bands may be included if energies from all specified bands are included in the data (in the sense of union).

restwav

public Double restwav

rest energy of the target energy transition (name changed in CAOM-2.5).

calibration

public CalibrationStatus calibration

term describing the calibration of the energy axis values (new in CAOM-2.5).

transition

public EnergyTransition transition

target energy transition for this data.

Constructor Details

EnergyBuilder

public EnergyBuilder()

Method Details

create

public Energy create()

create a Energy from this builder.

Returns:

an object initialized from the builder.