SpectralSimpleCube (HCSS - Developer's Reference Manual)

java.lang.Object
- herschel.ia.dataset.AbstractAnnotatable<T>
- - herschel.ia.dataset.AbstractComposite<Product>
  - - herschel.ia.dataset.Product
    - - herschel.ia.dataset.image.SimpleCube
      - herschel.ia.dataset.spectrum.SpectralSimpleCube

All Implemented Interfaces:

Annotatable, Attributable, Composite, DatasetBaseListener<Dataset>, DatasetListener, DataWrapperMapper, Cube, MetaDataHolder, Spectral<Double3d>, Spectral3d, SpectrumContainer<Double3d>, UnitInformationHolder, Copyable<Product>, Iterable<SpectralSegment>, EventListener
```
public class SpectralSimpleCube
extends SimpleCube
implements Spectral3d, SpectrumContainer<Double3d>
```
SpectralSimpleCube is a SimpleCube implementation where the 3rd axis represents a spectral axis. It is made such that both the image-toolkits and the spectrum-toolkits work on it. Contract: There are 3 axis in the cube: x1, x2 and x3. To be more specific, lets assume that x1 is the RA-axis, x2 is the DEC-axis and x3 is the Spectral-axis. Within the SpectralSimpleCube can be 1-d ArrayDatasets, 2-d ArrayDatasets and 3-d ArrayDatasets. 3-d sets are of dimension [x3,x2,x1] and are interpreted as spectral stacks of images. 2-d sets are of dimension [x2,x1] and are interpreted image-wise. 1-d sets are of dimension [x3] and are interpreted spectrum-wise. Other combinations of axes are not allowed (no [x3,x1] planes e.g) under penalty of loosing performance of the image/spectral toolkits.
Some instantiations of SpectralSimpleCube might contain an error cube instead of a weight cube. In order to make the spectrum toolboxes (ia.toolbox.spectrum) work there are provisions to convert these errors into weights. These automatically kick in when getWeight() is requested and no weight column could be found but only an error column. The toolbox operations would operate with the weights (possibly transforming them too) and then write back the (transformed) flux and the error (after being on-the-fly converted from the weight). See setWeight(herschel.ia.numeric.Double3d). This behaviour can be turned off by using setAutoConversion(boolean). The default of autoConversion is True.

Nested Class Summary
- Nested classes/interfaces inherited from class herschel.ia.dataset.Product
  Product.DatasetProductLinkedHashMap

Field Summary
- Fields inherited from class herschel.ia.dataset.image.SimpleCube
  COVERAGE, EXPOSURE, IMAGE
- Fields inherited from class herschel.ia.dataset.Product
  ATTRIBUTES, CREATION_DATE, CREATOR, DESCRIPTION, END_DATE, FORMATV, FORMATV_DESCRIPTION, FORMATV_INIT_VALUE, HISTORY, INSTRUMENT, MODEL_NAME, START_DATE, TYPE, UNKNOWN
- Fields inherited from interface herschel.ia.dataset.spectrum.SpectrumContainer
  CLASS, OPERATIONS
- Fields inherited from interface herschel.ia.dataset.spectrum.Spectral
  ERROR, FLAG, FLUX, MASK, SEGMENT, WAVE, WEIGHT

Constructor Summary

Constructors
Constructor and Description
`SpectralSimpleCube()` Default Constructor.
`SpectralSimpleCube(SimpleCube cube)` Copy Constructor from SimpleCube.
`SpectralSimpleCube(SpectralSimpleCube original)` Copy Constructor.
`SpectralSimpleCube(SpectrumContainer<?> s)` Constructor from a SpectrumContainer.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`append(PointSpectrum spectrum)` Append a PointSpectrum to the container.
`SpectralSimpleCube`	`copy()` Copy from a SpectralSimpleCube.
`ArrayData`	`error2Weight(Double3d error)` Returns a weight, given an error, as weight = 1/error^2.
`Set<String>`	`getAttributeNames()` Returns the names of the attributes that can be looked up for all the `PointSpectrum`'s contained in the `SpectrumContainer`.
`int`	`getColumnCount()` Returns the number of columns in a cube.
`boolean`	`getColumnFirst()` Returns the value of ColumnFirst.
`String`	`getCoordinateSystem()` Returns the Coordinate system.
`String`	`getDescription(String name)` Returns the Description of the Subset with name.
`double`	`getEquinox()` Returns the Epoch of the coordinate system.
`Double3d`	`getError()` Returns a reference to the error as a 3dim array.
`Short2d`	`getFlag(double wave)` Returns a copy of the flags pertaining to a 2-dim image nearest to wave.
`Short1d`	`getFlag(double lon, double lat)` Returns a copy of the flags pertaining to a 1-dim spectrum nearest to (lon,lat).
`short`	`getFlag(double lon, double lat, double wave)` Returns the flag of a pixel nearest to given positions.
`Short2d`	`getFlag(int depth)` Returns a copy of the flags pertaining to a 2-dim image at a depth.
`Short1d`	`getFlag(int row, int col)` Returns a copy of the flags pertaining to a 1-dim spectrum at a (row,col).
`short`	`getFlag(int depth, int row, int col)` Returns the flag of a pixel at the given position.
`Short3d`	`getFlagArray()` Returns a reference to the flag as a 3dim integer array.
`String`	`getFlagDescription()` Returns the description of the flag.
`Double3d`	`getFlux()` Returns a reference to the flux as a 3dim array.
`Numeric2dData`	`getFlux(double wave)` Returns a copy of the flux of a 2-dim image nearest spectral position.
`Numeric1dData`	`getFlux(double lon, double lat)` Returns a copy of the flux of a 1-dim spectrum nearest (lon,lat).
`Number`	`getFlux(double lon, double lat, double wave)` Returns the flux of a pixel at the given position.
`Double2d`	`getFlux(int depth)` Returns a copy of the flux of a 2-dim image at the given depth.
`Double1d`	`getFlux(int row, int col)` Returns a copy of the flux of a 1-dim spectrum at the given (row,col).
`Number`	`getFlux(int depth, int row, int col)` Returns the flux of a pixel at the given position.
`String`	`getFluxDescription()` Returns the description of the flux.
`Unit<?>`	`getFluxUnit()` Returns the units of the flux.
`int`	`getIndex(int row, int col)` Returns the index corresponding to [row,col].
`SpectralSimpleCube`	`getOutputTemplate()` Returns a copy of this container without the attribute objects.
`SpectralSimpleCube`	`getOutputTemplate(int size)` Return suitably initialized new instance of the given data structure.
`SpectralSimpleCube`	`getOutputTemplate(int[] imageSize)` Returns a container with given imagesize.
`SpectralSimpleCube`	`getOutputTemplate(int[] imageSize, int[] spectralSize)` Returns a container with given imagesize and spectralsize.
`SpectralSimpleCube`	`getOutputTemplate(int[] imageSize, int[] spectralSize, int[] segmentIdx)` Returns a container with given imagesize and spectralsize.
`SpectralSimpleCube`	`getOutputTemplate(int size, int[] segmentShape)` Return suitably initialized new instance of the given data structure.
`SpectralSimpleCube`	`getOutputTemplate(int size, int[] segmentShape, int[] segmentIdx)` Return suitably initialized new instance of the given data structure.
`int`	`getPlaneCount()` Returns the number of (image)planes in a cube.
`PointSpectrum`	`getPointSpectrum(int index)` Returns the PointSpectrum at the given index.
`PointSpectrum`	`getPointSpectrum(int row, int col)` Returns the PointSpectrum at the given position.
`int`	`getPointSpectrumCount()` Returns the number of PointSpectrums present in the container.
`int[]`	`getPointSpectrumDimension()` Returns the dimensions of the image [nrow,ncol].
`Iterator<PointSpectrum>`	`getPointSpectrumIterator()` Returns a iterator over the PointSpectrums.
`int`	`getRank()` Rank of this spectral object.
`int[]`	`getRowCol(int index)` Returns the [row,col] corresponding to index.
`int`	`getRowCount()` Returns the number of rows in a cube.
`int`	`getSegmentCount()` Returns s the number of segments within this Spectrum implementation.
`Set<String>`	`getSegmentedNames()` Returns the Set of Segmented Attribute names.
`int[]`	`getSegmentIndices()` Returns a list of SpectralSegment indices in the PointSpectrum.
`List<PointSpectrum>`	`getSelection(SelectionModel selectionModel)` Returns a list of PointSpectrums present in the SelectionModel.
`int`	`getSize()` Returns the dimensions of the image [nrow,ncol].
`SpectralSegment`	`getSpectralSegment()` Get access to the first spectral segment within this Spectrum.
`SpectralSegment`	`getSpectralSegment(int index)` Get access to a specific spectral segment within this Spectrum.
`SpectralSegment`	`getSpectralSegment(int row, int col)` Get access to a specific spectral segment within this Spectrum.
`Iterator<SpectralSegment>`	`getSpectralSegmentIterator()` Returns an iterator over SpectralSegment.
`Iterator<SpectralSegment>`	`getSpectralSegmentIterator(int index)` Returns iterator starting at this index.
`Iterator<SpectralSegment>`	`getSpectralSegmentIterator(int row, int col)` Returns iterator starting at this row and col.
`Spectrum1d`	`getSpectrum1d(int row, int col)` Returns the Spectrum1d at the given position.
`ArrayDataset`	`getSubset(String name)` Returns the subset (ArrayDataset); null if not found.
`int`	`getSubsetCount()` Returns the number of subsets.
`String1d`	`getSubsetNames()` Returns the names of the subsets.
`Unit<?>`	`getUnit()` Returns the unit of the cube.
`Unit<?>`	`getUnit(String name)` Returns the Unit of the Subset with name.
`UnitInformation`	`getUnitInformation()` Returns interface that provides access to the unit information of the data included in the container.
`Double1d`	`getWave()` Returns a copy the wave as a 1-dim array.
`Double1d`	`getWave(double lon, double lat)` Returns the wave of a 1-dim spectrum nearest (lon,lat).
`double`	`getWave(int depth)` Returns the wave at the given depth.
`Double1d`	`getWave(int row, int col)` Returns the wave of a 1-dim spectrum at the given (row,col).
`double`	`getWave(int depth, int row, int col)` Returns the wave of a pixel at the given position.
`Double1d`	`getWave(Unit<?> unit)` Returns a copy the wave as a 1-dim array in the requested unit.
`String`	`getWaveDescription()` Returns the description of the wave.
`Unit<?>`	`getWaveUnit()` Returns the units of the wave.
`Double3d`	`getWeight()` Returns a reference to the weight as a 3dim array.
`Double2d`	`getWeight(double wave)` Returns a copy of the weight of a 2-dim image nearest spectral position.
`Double1d`	`getWeight(double lon, double lat)` Returns a copy of the weight of a 1-dim spectrum nearest (lon,lat).
`double`	`getWeight(double lon, double lat, double wave)` Returns the weight of a pixel at the given position.
`Double2d`	`getWeight(int depth)` Returns a copy of the weight of a 2-dim image at the given depth.
`Double1d`	`getWeight(int row, int col)` Returns a copy of the weight of a 1-dim spectrum at the given (row,col).
`double`	`getWeight(int depth, int row, int col)` Returns the weight of a pixel at the given position.
`String`	`getWeightDescription()` Returns the description of the weight.
`boolean`	`hasError()` Returns true if a error dataset is present.
`boolean`	`hasSubset(String name)` Returns true if it has a subset of name.
`boolean`	`hasWeight()` Returns true if a weight dataset is present.
`boolean`	`include(PointSpectrum spectrum)` Include a PointSpectrum at its own location.
`boolean`	`include(PointSpectrum spectrum, int index)` Include a PointSpectrum at a given index.
`Iterator<SpectralSegment>`	`iterator()` An iterator over all spectral segments.
`int[]`	`nearestPixels(double lon, double lat)` Returns the nearest image pixels to a given (lon,lat).
`int`	`nearestPlane(double otherWave)` Returns the nearest (image)plane to a given wave.
`void`	`setAutoConversion(boolean val)` set automatic conversion from error to weight.
`void`	`setColumnFirst(boolean columnFirst)` Set the segment counter to Column first.
`void`	`setDescription(String name, String desc)` Set the description of name.
`void`	`setError(Double3d error)` Set the error cube.
`void`	`setFlag(int row, int col, Int1d flag)` Set the flag of a 1-dim spectrum at the given (row,col).
`void`	`setFlag(int depth, int row, int col, short flag)` Set the flag of a pixel at the given position.
`void`	`setFlag(int row, int col, Short1d flag)` Set the flag of a 1-dim spectrum at the given (row,col).
`void`	`setFlag(int depth, Short2d flag)` Set the flag of a 2-dim image at the given depth.
`void`	`setFlag(Short3d flag)` Set the flag cube.
`void`	`setFlagDescription(String description)` Set the description of the flag.
`void`	`setFlux(Double3d flux)` Set the flux (==Image) cube.
`void`	`setFlux(int row, int col, Double1d flux)` Set the flux of a 1-dim spectrum at the given (row,col).
`void`	`setFlux(int depth, int row, int col, Number flux)` Set the flux of a pixel at the given position.
`void`	`setFlux(int depth, Numeric2dData flux)` Set the flux of a 2-dim image at the given depth.
`void`	`setFluxDescription(String description)` Set the description of the flux.
`void`	`setFluxUnit(Unit<?> unit)` Set the unit of the flux.
`void`	`setUnit(String name, Unit<?> unit)` Set the units of name.
`void`	`setUnit(Unit<?> unit)` Sets the unit of the cube.
`void`	`setWave(Double1d wave)` Set the wave.
`void`	`setWave(Double1d double1d, Unit<?> unit)` Set the wave.
`void`	`setWave(DoubleArray wave)` Set the wave.
`void`	`setWave(int depth, double wave)` Set the wave of a 2-dim image at the given depth.
`void`	`setWave(int row, int col, Double1d wave)` Throws IndexOutOfBoundsException.
`void`	`setWave(int depth, int row, int col, Number wave)` Throws IndexOutOfBoundsException.
`void`	`setWaveDescription(String description)` Set the description of the wave.
`void`	`setWaveUnit(Unit<?> unit)` Set the unit of the wave.
`void`	`setWeight(Double3d weight)` Set the weight cube.
`void`	`setWeight(int depth, Double2d weight)` Set the weight of a 2-dim image at the given depth.
`void`	`setWeight(int row, int col, Double1d weight)` Set the weight of a 1-dim spectrum at the given (row,col).
`void`	`setWeight(int depth, int row, int col, double weight)` Set the weight of a pixel at the given position.
`void`	`setWeightDescription(String description)` Set the description of the weight.
`protected IndexIterator`	`slice1d(int row, int col, int[] dim)` Returns a 1d slice of a cube at a image position.
`protected IndexIterator`	`slice2d(int depth, int[] dim)` Returns a 2d slice of a cube at a spectral position.
`ArrayData`	`weight2Error(ArrayData weight)` Returns a error, given an weight, as error = 1/ SQRT(weight).

Methods inherited from class herschel.ia.dataset.image.SimpleCube
getCoverage, getDataset, getDepth, getDimensions, getExposure, getFlag, getHeight, getImage, getIntensity, getIntensityWorldCoordinates, getPixel, getPreview, getSimpleImage, getWcs, getWidth, hasCoverage, hasExposure, hasFlag, removeCoverage, removeError, removeExposure, removeFlag, setCoverage, setCoverage, setCoverage, setError, setError, setExposure, setExposure, setExposure, setFlag, setFlag, setImage, setImage, setImage, setIntensity, setUnit, setUnit, setWcs

Methods inherited from class herschel.ia.dataset.Product
accept, addProductListener, contentsToString, equals, getCreationDate, getCreator, getDefault, getDescription, getDuration, getDurationText, getEndDate, getFormatVersion, getHistory, getInstrument, getModelName, getOwner, getSets, getStartDate, getType, hashCode, removeProductListener, setCreationDate, setCreator, setDescription, setEndDate, setFormatVersion, setHistory, setInstrument, setMeta, setModelName, setOwner, setStartDate, setType

Methods inherited from class herschel.ia.dataset.AbstractComposite
__getitem__, __setitem__, containsKey, get, getDataWrappers, getMeta, isEmpty, keySet, remove, set, size, targetChanged

Methods inherited from class herschel.ia.dataset.AbstractAnnotatable
getEventSupport, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface herschel.ia.dataset.spectrum.SpectrumContainer
__add__, __div__, __iadd__, __idiv__, __imul__, __isub__, __mul__, __radd__, __rdiv__, __rmul__, __rsub__, __sub__, getSpectrumClass

Methods inherited from interface herschel.ia.dataset.Attributable
getMeta, setMeta

Methods inherited from interface herschel.ia.dataset.spectrum.Spectral
hasFlux, hasWave

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface herschel.ia.dataset.image.Cube
getDescription, setDescription

- Constructor Detail
  - SpectralSimpleCube
```
public SpectralSimpleCube()
```
    Default Constructor.
  - SpectralSimpleCube
```
public SpectralSimpleCube(SpectralSimpleCube original)
```
    Copy Constructor.
    
    Parameters:
    
    original - the SpectralSimpleCube to be copied
  - SpectralSimpleCube
```
public SpectralSimpleCube(SimpleCube cube)
```
    Copy Constructor from SimpleCube.
    
    Parameters:
    
    cube - the SimpleCube to be copied
  - SpectralSimpleCube
```
public SpectralSimpleCube(SpectrumContainer<?> s)
```
    Constructor from a SpectrumContainer.
    
    Parameters:
    
    s - SpectrumContainer to be copied and converted into a Spectrum1d
- Method Detail
  - copy
```
public SpectralSimpleCube copy()
```
    Copy from a SpectralSimpleCube.
    
    Specified by:
    
    copy in interface Cube
    
    Specified by:
    
    copy in interface Copyable<Product>
    
    Overrides:
    
    copy in class SimpleCube
    
    Returns:
    
    a copy from a SpectralSimpleCube.
  - iterator
```
public Iterator<SpectralSegment> iterator()
```
    An iterator over all spectral segments. Same as getSpectralSegmentIterator().
    
    Specified by:
    
    iterator in interface Spectral<Double3d>
    
    Specified by:
    
    iterator in interface Iterable<SpectralSegment>
    
    Returns:
    
    An iterator over all spectral segments.
  - getRank
```
public int getRank()
```
    Rank of this spectral object.
    
    Specified by:
    
    getRank in interface Spectral<Double3d>
    
    Returns:
    
    3
  - getSegmentCount
```
public int getSegmentCount()
```
    Returns s the number of segments within this Spectrum implementation.
    
    Specified by:
    
    getSegmentCount in interface Spectral<Double3d>
    
    Returns:
    
    s the number of segments within this Spectrum implementation.
  - getSpectralSegmentIterator
```
public Iterator<SpectralSegment> getSpectralSegmentIterator()
```
    Returns an iterator over SpectralSegment.
    
    Specified by:
    
    getSpectralSegmentIterator in interface Spectral<Double3d>
    
    Returns:
    
    an iterator over SpectralSegment.
  - getSpectralSegmentIterator
```
public Iterator<SpectralSegment> getSpectralSegmentIterator(int index)
```
    Returns iterator starting at this index.
    
    Parameters:
    
    index - at this index
    
    Returns:
    
    iterator starting at this index.
  - getSpectralSegmentIterator
```
public Iterator<SpectralSegment> getSpectralSegmentIterator(int row,
                                                            int col)
```
    Returns iterator starting at this row and col.
    
    Parameters:
    
    row - at this row
    
    col - at this column
    
    Returns:
    
    iterator starting at this row and col.
  - getSpectralSegment
```
public SpectralSegment getSpectralSegment(int index)
```
    Get access to a specific spectral segment within this Spectrum.
    
    Specified by:
    
    getSpectralSegment in interface Spectral<Double3d>
    
    Parameters:
    
    index - of the segment
    
    Returns:
    
    a specific spectral segment within this Spectrum.
  - getSpectralSegment
```
public SpectralSegment getSpectralSegment(int row,
                                          int col)
```
    Get access to a specific spectral segment within this Spectrum.
    
    Parameters:
    
    row - at this row (latitude)
    
    col - at this column (longitude)
    
    Returns:
    
    a specific spectral segment within this Spectrum.
  - getSpectralSegment
```
public SpectralSegment getSpectralSegment()
```
    Get access to the first spectral segment within this Spectrum.
    
    Returns:
    
    the first spectral segment within this Spectrum.
  - setColumnFirst
```
public void setColumnFirst(boolean columnFirst)
```
    Set the segment counter to Column first.
    The segments are returned in natural order, iterating first over the longitude (dimension[2]) and then over the latitude (dimension[1])
    Default is true.
    Note: If you want to use this method, you have to call it before you construct the iterator.
    
    Parameters:
    
    columnFirst - true for columns first
  - getColumnFirst
```
public final boolean getColumnFirst()
```
    Returns the value of ColumnFirst.
    
    Specified by:
    
    getColumnFirst in interface Spectral3d
    
    Returns:
    
    the value of ColumnFirst.
  - getIndex
```
public int getIndex(int row,
                    int col)
```
    Returns the index corresponding to [row,col].
    
    Parameters:
    
    row - the row (lat index)
    
    col - the column (lon index)
    
    Returns:
    
    the index corresponding to [row,col].
  - getRowCol
```
public int[] getRowCol(int index)
```
    Returns the [row,col] corresponding to index. Reverse of getIndex( row, col )
    
    Parameters:
    
    index - the index
    
    Returns:
    
    the [row,col] corresponding to index.
  - getSubset
```
public ArrayDataset getSubset(String name)
```
    Returns the subset (ArrayDataset); null if not found.
    
    Specified by:
    
    getSubset in interface Spectral<Double3d>
    
    Parameters:
    
    name - the name to be looked for
    
    Returns:
    
    the subset (ArrayDataset); null if not found.
  - hasSubset
```
public boolean hasSubset(String name)
```
    Returns true if it has a subset of name.
    
    Specified by:
    
    hasSubset in interface Spectral<Double3d>
    
    Parameters:
    
    name - the name to be looked for
    
    Returns:
    
    true if it has a subset of name.
  - getSubsetCount
```
public int getSubsetCount()
```
    Returns the number of subsets.
    
    Specified by:
    
    getSubsetCount in interface Spectral<Double3d>
    
    Returns:
    
    the number of subsets.
  - getSubsetNames
```
public String1d getSubsetNames()
```
    Returns the names of the subsets.
    
    Specified by:
    
    getSubsetNames in interface Spectral<Double3d>
    
    Returns:
    
    the names of the subsets.
  - getPlaneCount
```
public int getPlaneCount()
```
    Returns the number of (image)planes in a cube. equivalent to getDepth() or length of dimension[0], ie. Spectral.
    
    Returns:
    
    the number of (image)planes in a cube.
  - getRowCount
```
public int getRowCount()
```
    Returns the number of rows in a cube. equivalent to getHeight() or length of dimension[1], ie. Latitude.
    
    Specified by:
    
    getRowCount in interface Spectral3d
    
    Returns:
    
    the number of rows in a cube.
  - getColumnCount
```
public int getColumnCount()
```
    Returns the number of columns in a cube. equivalent to getWidth() or length of dimension[2], ie. Longitude.
    
    Specified by:
    
    getColumnCount in interface Spectral3d
    
    Returns:
    
    the number of columns in a cube.
  - getSpectrum1d
```
public Spectrum1d getSpectrum1d(int row,
                                int col)
```
    Returns the Spectrum1d at the given position.
    
    Parameters:
    
    row - the row (1st) index
    
    col - the column (2nd) index
    
    Returns:
    
    the Spectrum1d at the given position.
  - getFlux
```
public Double3d getFlux()
```
    Returns a reference to the flux as a 3dim array.
    
    Specified by:
    
    getFlux in interface Spectral<Double3d>
    
    Returns:
    
    a reference to the flux as a 3dim array.
  - getFlux
```
public Double2d getFlux(int depth)
```
    Returns a copy of the flux of a 2-dim image at the given depth.
    
    Parameters:
    
    depth - spectral depth
    
    Returns:
    
    a copy of the flux of a 2-dim image at the given depth.
  - getFlux
```
public Double1d getFlux(int row,
                        int col)
```
    Returns a copy of the flux of a 1-dim spectrum at the given (row,col).
    
    Specified by:
    
    getFlux in interface Spectral3d
    
    Parameters:
    
    row - row index
    
    col - col index
    
    Returns:
    
    a copy of the flux of a 1-dim spectrum at the given (row,col).
  - getFlux
```
public Number getFlux(int depth,
                      int row,
                      int col)
```
    Returns the flux of a pixel at the given position.
    
    Parameters:
    
    depth - spectral index
    
    row - the row index of the image
    
    col - the column index
    
    Returns:
    
    the flux of a pixel at the given position.
  - getFlux
```
public Numeric2dData getFlux(double wave)
```
    Returns a copy of the flux of a 2-dim image nearest spectral position.
    
    Parameters:
    
    wave - spectral position to be searched for.
    
    Returns:
    
    a copy of the flux of a 2-dim image nearest spectral position.
  - getFlux
```
public Numeric1dData getFlux(double lon,
                             double lat)
```
    Returns a copy of the flux of a 1-dim spectrum nearest (lon,lat).
    
    Parameters:
    
    lon - longitude to be searched for.
    
    lat - latitude to be searched for.
    
    Returns:
    
    a copy of the flux of a 1-dim spectrum nearest (lon,lat).
  - getFlux
```
public Number getFlux(double lon,
                      double lat,
                      double wave)
```
    Returns the flux of a pixel at the given position.
    
    Parameters:
    
    lon - longitude to be searched for.
    
    lat - latitude to be searched for.
    
    wave - spectral position to be searched for.
    
    Returns:
    
    the flux of a pixel at the given position.
  - setFlux
```
public void setFlux(Double3d flux)
```
    Set the flux (==Image) cube.
    
    Specified by:
    
    setFlux in interface Spectral<Double3d>
    
    Parameters:
    
    flux - the flux
  - setFlux
```
public void setFlux(int depth,
                    Numeric2dData flux)
```
    Set the flux of a 2-dim image at the given depth.
    
    Parameters:
    
    depth - spectral index
    
    flux - for the image
  - setFlux
```
public void setFlux(int row,
                    int col,
                    Double1d flux)
```
    Set the flux of a 1-dim spectrum at the given (row,col).
    
    Specified by:
    
    setFlux in interface Spectral3d
    
    Parameters:
    
    row - the row index
    
    col - the column index
    
    flux - for the spectrum
  - setFlux
```
public void setFlux(int depth,
                    int row,
                    int col,
                    Number flux)
```
    Set the flux of a pixel at the given position.
    
    Parameters:
    
    depth - spectral index
    
    row - the row index
    
    col - the column index
    
    flux - for the pixel
  - getWave
```
public Double1d getWave(Unit<?> unit)
```
    Returns a copy the wave as a 1-dim array in the requested unit.
    
    Parameters:
    
    unit - the unit to return the wave in.
    
    Returns:
    
    a copy the wave as a 1-dim array in the requested unit.
  - getWave
```
public Double1d getWave()
```
    Returns a copy the wave as a 1-dim array.
    
    Specified by:
    
    getWave in interface Spectral<Double3d>
    
    Returns:
    
    a copy the wave as a 1-dim array.
  - getWave
```
public double getWave(int depth)
```
    Returns the wave at the given depth.
    
    Parameters:
    
    depth - spectral index
    
    Returns:
    
    the wave at the given depth.
  - getWave
```
public Double1d getWave(int row,
                        int col)
```
    Returns the wave of a 1-dim spectrum at the given (row,col). Same as getWave()
    
    Specified by:
    
    getWave in interface Spectral3d
    
    Parameters:
    
    row - the row index
    
    col - the column index
    
    Returns:
    
    the wave of a 1-dim spectrum at the given (row,col).
  - getWave
```
public double getWave(int depth,
                      int row,
                      int col)
```
    Returns the wave of a pixel at the given position. Same as getWave( depth )
    
    Parameters:
    
    depth - spectral index
    
    row - the row index
    
    col - the column index
    
    Returns:
    
    the wave of a pixel at the given position.
  - getWave
```
public Double1d getWave(double lon,
                        double lat)
```
    Returns the wave of a 1-dim spectrum nearest (lon,lat).
    
    Parameters:
    
    lon - longitude to be searched for.
    
    lat - latitude to be searched for.
    
    Returns:
    
    the wave of a 1-dim spectrum nearest (lon,lat).
  - setWave
```
public void setWave(Double1d double1d,
                    Unit<?> unit)
```
    Set the wave.
    
    Parameters:
    
    double1d - assuming it is NOT equidistant (otherwise change Wcs).
    
    unit - the unit in which the wave is given.
  - setWave
```
public void setWave(Double1d wave)
```
    Set the wave. If CUNIT3 is present in WCS this unit is used, otherwise no unit (null) will be used.
    
    Specified by:
    
    setWave in interface Spectral3d
    
    Parameters:
    
    wave - assuming it is NOT equidistant (otherwise change Wcs).
  - setWave
```
public void setWave(DoubleArray wave)
```
    Set the wave. If CUNIT3 is present in WCS this unit is used, otherwise no unit (null) will be used.
    
    Specified by:
    
    setWave in interface Spectral<Double3d>
    
    Parameters:
    
    wave - assuming it is NOT equidistant (otherwise change Wcs).
  - setWave
```
public void setWave(int depth,
                    double wave)
```
    Set the wave of a 2-dim image at the given depth.
    
    Parameters:
    
    depth - spectral index
    
    wave - for the image
  - setWave
```
public void setWave(int row,
                    int col,
                    Double1d wave)
```
    Throws IndexOutOfBoundsException.
    It is not possible to set the wave of a 1-dim spectrum at a given (row,col).
    
    Specified by:
    
    setWave in interface Spectral3d
    
    Parameters:
    
    row - the row index
    
    col - the column index
    
    wave - for the spectrum
    
    Throws:
    
    IndexOutOfBoundsException - It is not possible to set wave at specific image locations.
  - setWave
```
public void setWave(int depth,
                    int row,
                    int col,
                    Number wave)
```
    Throws IndexOutOfBoundsException.
    It is not possible to set the wave of a pixel at a given position.
    
    Parameters:
    
    depth - spectral index
    
    row - the row index
    
    col - the column index
    
    wave - for the pixel
  - hasWeight
```
public boolean hasWeight()
```
    Returns true if a weight dataset is present.
    
    Specified by:
    
    hasWeight in interface Spectral<Double3d>
    
    Returns:
    
    true if a weight dataset is present.
  - hasError
```
public boolean hasError()
```
    Returns true if a error dataset is present.
    
    Specified by:
    
    hasError in interface Cube
    
    Specified by:
    
    hasError in interface Spectral<Double3d>
    
    Overrides:
    
    hasError in class SimpleCube
    
    Returns:
    
    true if a error dataset is present.
  - getWeight
```
public Double3d getWeight()
```
    Returns a reference to the weight as a 3dim array.
    In absence of a weight it tries to return the inverse square of the error, as a measure of the weight.
    
    Specified by:
    
    getWeight in interface Spectral<Double3d>
    
    Returns:
    
    a reference to the weight as a 3dim array.
    
    Throws:
    
    IndexOutOfBoundsException - when neither weight nor error is found
  - getWeight
```
public Double2d getWeight(int depth)
```
    Returns a copy of the weight of a 2-dim image at the given depth.
    In absence of a weight it tries to return the inverse square of the error, as a measure of the weight.
    
    Parameters:
    
    depth - spectral index
    
    Returns:
    
    a copy of the weight of a 2-dim image at the given depth.
  - getWeight
```
public Double1d getWeight(int row,
                          int col)
```
    Returns a copy of the weight of a 1-dim spectrum at the given (row,col).
    In absence of a weight it tries to return the inverse square of the error, as a measure of the weight.
    
    Specified by:
    
    getWeight in interface Spectral3d
    
    Parameters:
    
    row - the row index
    
    col - the column index
    
    Returns:
    
    a copy of the weight of a 1-dim spectrum at the given (row,col).
  - getWeight
```
public double getWeight(int depth,
                        int row,
                        int col)
```
    Returns the weight of a pixel at the given position.
    In absence of a weight it tries to return the inverse square of the error, as a measure of the weight.
    
    Parameters:
    
    depth - spectral index
    
    row - the row index
    
    col - the column index
    
    Returns:
    
    the weight of a pixel at the given position.
  - getWeight
```
public Double2d getWeight(double wave)
```
    Returns a copy of the weight of a 2-dim image nearest spectral position.
    In absence of a weight it tries to return the inverse square of the error, as a measure of the weight.
    
    Parameters:
    
    wave - spectral position to be searched for.
    
    Returns:
    
    a copy of the weight of a 2-dim image nearest spectral position.
  - getWeight
```
public Double1d getWeight(double lon,
                          double lat)
```
    Returns a copy of the weight of a 1-dim spectrum nearest (lon,lat).
    In absence of a weight it tries to return the inverse square of the error, as a measure of the weight.
    
    Parameters:
    
    lon - longitude to be searched for.
    
    lat - latitude to be searched for.
    
    Returns:
    
    a copy of the weight of a 1-dim spectrum nearest (lon,lat).
  - getWeight
```
public double getWeight(double lon,
                        double lat,
                        double wave)
```
    Returns the weight of a pixel at the given position.
    In absence of a weight it tries to return the inverse square of the error, as a measure of the weight.
    
    Parameters:
    
    lon - longitude to be searched for.
    
    lat - latitude to be searched for.
    
    wave - spectral position to be searched for.
    
    Returns:
    
    the weight of a pixel at the given position.
  - setWeight
```
public void setWeight(Double3d weight)
```
    Set the weight cube.
    For writing or replacing the following logic is used:
```
 if ( weight cube is present ) replace it
 else if ( error cube is present ) replace it with 1 / sqrt(weight)
 else write new weight cube.
 
```
    Specified by:
    
    setWeight in interface Spectral<Double3d>
    
    Parameters:
    
    weight - the weight
  - setWeight
```
public void setWeight(int depth,
                      Double2d weight)
```
    Set the weight of a 2-dim image at the given depth.
    for behaviour of weight/error see setWeight(Double3d)
    
    Parameters:
    
    depth - spectral index
    
    weight - for the image
  - setWeight
```
public void setWeight(int row,
                      int col,
                      Double1d weight)
```
    Set the weight of a 1-dim spectrum at the given (row,col).
    for behaviour of weight/error see setWeight(Double3d)
    
    Specified by:
    
    setWeight in interface Spectral3d
    
    Parameters:
    
    row - the row index
    
    col - the column index
    
    weight - for the spectrum
  - setWeight
```
public void setWeight(int depth,
                      int row,
                      int col,
                      double weight)
```
    Set the weight of a pixel at the given position.
    for behaviour of weight/error see setWeight(Double3d)
    
    Parameters:
    
    depth - spectral index
    
    row - the row index
    
    col - the column index
    
    weight - for the pixel
  - getError
```
public Double3d getError()
```
    Returns a reference to the error as a 3dim array.
    
    Specified by:
    
    getError in interface Cube
    
    Specified by:
    
    getError in interface Spectral<Double3d>
    
    Overrides:
    
    getError in class SimpleCube
    
    Returns:
    
    a reference to the error as a 3dim array.
    
    Throws:
    
    IndexOutOfBoundsException - when error is not found
  - setError
```
public void setError(Double3d error)
```
    Set the error cube.
    For writing or replacing the following logic is used:
```
 if ( weight cube is present ) replace it
 else if ( error cube is present ) replace it with 1 / sqrt(weight)
 else write new weight cube.
 
```
    Specified by:
    
    setError in interface Spectral<Double3d>
    
    Parameters:
    
    error - the error
  - setAutoConversion
```
public void setAutoConversion(boolean val)
```
    set automatic conversion from error to weight.
    
    Parameters:
    
    val - false/true
  - error2Weight
```
public ArrayData error2Weight(Double3d error)
```
    Returns a weight, given an error, as weight = 1/error^2.
    Overload for other conversions.
    
    Parameters:
    
    error - to be converted.
    
    Returns:
    
    a weight, given an error, as weight = 1/error^2.
  - weight2Error
```
public ArrayData weight2Error(ArrayData weight)
```
    Returns a error, given an weight, as error = 1/ SQRT(weight).
    Overload for other conversions.
    
    Parameters:
    
    weight - to be converted.
    
    Returns:
    
    a error, given an weight, as error = 1/ SQRT(weight).
  - getFlagArray
```
public Short3d getFlagArray()
```
    Returns a reference to the flag as a 3dim integer array.
    
    Returns:
    
    a reference to the flag as a 3dim integer array.
  - getFlag
```
public Short2d getFlag(int depth)
```
    Returns a copy of the flags pertaining to a 2-dim image at a depth.
    
    Parameters:
    
    depth - spectral index
    
    Returns:
    
    a copy of the flags pertaining to a 2-dim image at a depth.
  - getFlag
```
public Short1d getFlag(int row,
                       int col)
```
    Returns a copy of the flags pertaining to a 1-dim spectrum at a (row,col).
    
    Specified by:
    
    getFlag in interface Spectral3d
    
    Parameters:
    
    row - the row index
    
    col - the column index
    
    Returns:
    
    a copy of the flags pertaining to a 1-dim spectrum at a (row,col).
  - getFlag
```
public short getFlag(int depth,
                     int row,
                     int col)
```
    Returns the flag of a pixel at the given position.
    
    Parameters:
    
    depth - spectral index
    
    row - the row index
    
    col - the column index
    
    Returns:
    
    the flag of a pixel at the given position.
  - getFlag
```
public Short2d getFlag(double wave)
```
    Returns a copy of the flags pertaining to a 2-dim image nearest to wave.
    
    Parameters:
    
    wave - spectral position to be searched for.
    
    Returns:
    
    a copy of the flags pertaining to a 2-dim image nearest to wave.
  - getFlag
```
public Short1d getFlag(double lon,
                       double lat)
```
    Returns a copy of the flags pertaining to a 1-dim spectrum nearest to (lon,lat).
    
    Parameters:
    
    lon - longitude to be searched for.
    
    lat - latitude to be searched for.
    
    Returns:
    
    a copy of the flags pertaining to a 1-dim spectrum nearest
  - getFlag
```
public short getFlag(double lon,
                     double lat,
                     double wave)
```
    Returns the flag of a pixel nearest to given positions.
    
    Parameters:
    
    lon - longitude to be searched for.
    
    lat - latitude to be searched for.
    
    wave - spectral position to be searched for.
    
    Returns:
    
    the flag of a pixel nearest to given positions.
  - setFlag
```
public void setFlag(Short3d flag)
```
    Set the flag cube.
    
    Parameters:
    
    flag - the flag
  - setFlag
```
public void setFlag(int depth,
                    Short2d flag)
```
    Set the flag of a 2-dim image at the given depth.
    
    Parameters:
    
    depth - spectral index
    
    flag - for the image
  - setFlag
```
public void setFlag(int row,
                    int col,
                    Short1d flag)
```
    Set the flag of a 1-dim spectrum at the given (row,col).
    
    Specified by:
    
    setFlag in interface Spectral3d
    
    Parameters:
    
    row - the row index
    
    col - the column index
    
    flag - for the spectrum
  - setFlag
```
public void setFlag(int row,
                    int col,
                    Int1d flag)
```
    Set the flag of a 1-dim spectrum at the given (row,col). NOTE the flag will be cut back to Short1d.
    
    Parameters:
    
    row - the row index
    
    col - the column index
    
    flag - for the spectrum
  - setFlag
```
public void setFlag(int depth,
                    int row,
                    int col,
                    short flag)
```
    Set the flag of a pixel at the given position.
    
    Parameters:
    
    depth - spectral index
    
    row - the row index
    
    col - the column index
    
    flag - for the pixel
  - getUnit
```
public Unit<?> getUnit()
```
    Description copied from class: SimpleCube
    
    Returns the unit of the cube. The unit of the errors on the cube is the same as the unit of the cube.
    
    Specified by:
    
    getUnit in interface Cube
    
    Overrides:
    
    getUnit in class SimpleCube
    
    Returns:
    
    The unit of the cube
  - setUnit
```
public void setUnit(Unit<?> unit)
```
    Description copied from class: SimpleCube
    
    Sets the unit of the cube. Adapting the unit of the cube will also adapt the unit of the errors on the cube.
    
    Specified by:
    
    setUnit in interface Cube
    
    Overrides:
    
    setUnit in class SimpleCube
    
    Parameters:
    
    unit - The unit of the image/cube
  - getFluxUnit
```
public Unit<?> getFluxUnit()
```
    Returns the units of the flux.
    
    Specified by:
    
    getFluxUnit in interface Spectral<Double3d>
    
    Returns:
    
    the units of the flux.
  - getWaveUnit
```
public Unit<?> getWaveUnit()
```
    Returns the units of the wave.
    
    Specified by:
    
    getWaveUnit in interface Spectral<Double3d>
    
    Returns:
    
    the units of the wave.
  - getUnit
```
public Unit<?> getUnit(String name)
```
    Returns the Unit of the Subset with name.
    
    Specified by:
    
    getUnit in interface Spectral<Double3d>
    
    Overrides:
    
    getUnit in class SimpleCube
    
    Parameters:
    
    name - for which the Unit is requested
    
    Returns:
    
    the Unit of the Subset with name.
  - getDescription
```
public String getDescription(String name)
```
    Returns the Description of the Subset with name.
    
    Specified by:
    
    getDescription in interface Spectral<Double3d>
    
    Parameters:
    
    name - for which the desription is requested
    
    Returns:
    
    the Description of the Subset with name.
  - getFluxDescription
```
public String getFluxDescription()
```
    Returns the description of the flux.
    
    Specified by:
    
    getFluxDescription in interface Spectral<Double3d>
    
    Returns:
    
    the description of the flux.
  - getWaveDescription
```
public String getWaveDescription()
```
    Returns the description of the wave.
    
    Specified by:
    
    getWaveDescription in interface Spectral<Double3d>
    
    Returns:
    
    the description of the wave.
  - getWeightDescription
```
public String getWeightDescription()
```
    Returns the description of the weight.
    
    Specified by:
    
    getWeightDescription in interface Spectral<Double3d>
    
    Returns:
    
    the description of the weight.
  - getFlagDescription
```
public String getFlagDescription()
```
    Returns the description of the flag.
    
    Specified by:
    
    getFlagDescription in interface Spectral<Double3d>
    
    Returns:
    
    the description of the flag.
  - getCoordinateSystem
```
public String getCoordinateSystem()
```
    Returns the Coordinate system.
    
    Specified by:
    
    getCoordinateSystem in interface Spectral<Double3d>
    
    Returns:
    
    the Coordinate system.
  - getEquinox
```
public double getEquinox()
```
    Returns the Epoch of the coordinate system.
    
    Specified by:
    
    getEquinox in interface Spectral<Double3d>
    
    Returns:
    
    the Epoch of the coordinate system.
  - setFluxUnit
```
public void setFluxUnit(Unit<?> unit)
```
    Set the unit of the flux.
    
    Specified by:
    
    setFluxUnit in interface Spectral<Double3d>
    
    Parameters:
    
    unit - the unit
  - setWaveUnit
```
public void setWaveUnit(Unit<?> unit)
```
    Set the unit of the wave.
    
    Specified by:
    
    setWaveUnit in interface Spectral<Double3d>
    
    Parameters:
    
    unit - the unit
  - setUnit
```
public void setUnit(String name,
                    Unit<?> unit)
```
    Set the units of name.
    
    Specified by:
    
    setUnit in interface Spectral<Double3d>
    
    Overrides:
    
    setUnit in class SimpleCube
    
    Parameters:
    
    name - of subset
    
    unit - of subset
  - setDescription
```
public void setDescription(String name,
                           String desc)
```
    Set the description of name.
    
    Specified by:
    
    setDescription in interface Spectral<Double3d>
    
    Parameters:
    
    name - of subset
    
    desc - of subset
  - setFluxDescription
```
public void setFluxDescription(String description)
```
    Set the description of the flux.
    
    Specified by:
    
    setFluxDescription in interface Spectral<Double3d>
    
    Parameters:
    
    description - the description
  - setWaveDescription
```
public void setWaveDescription(String description)
```
    Set the description of the wave.
    
    Specified by:
    
    setWaveDescription in interface Spectral<Double3d>
    
    Parameters:
    
    description - the description
  - setWeightDescription
```
public void setWeightDescription(String description)
```
    Set the description of the weight.
    
    Specified by:
    
    setWeightDescription in interface Spectral<Double3d>
    
    Parameters:
    
    description - the description
  - setFlagDescription
```
public void setFlagDescription(String description)
```
    Set the description of the flag.
    
    Specified by:
    
    setFlagDescription in interface Spectral<Double3d>
    
    Parameters:
    
    description - the description
  - nearestPlane
```
public int nearestPlane(double otherWave)
```
    Returns the nearest (image)plane to a given wave.
    
    Parameters:
    
    otherWave - the wave to be searched for.
    
    Returns:
    
    the nearest (image)plane to a given wave.
  - nearestPixels
```
public int[] nearestPixels(double lon,
                           double lat)
```
    Returns the nearest image pixels to a given (lon,lat). BEWARE: The returned pixels are in the reversed order (row,col)
    
    Parameters:
    
    lon - longitude to be searched for.
    
    lat - latitude to be searched for.
    
    Returns:
    
    the nearest image pixels to a given (lon,lat).
  - getPointSpectrum
```
public PointSpectrum getPointSpectrum(int index)
```
    Returns the PointSpectrum at the given index. For internal use only. Better use getSpectrum1d(int,int).
    
    Specified by:
    
    getPointSpectrum in interface Spectral<Double3d>
    
    Parameters:
    
    index - the index
    
    Returns:
    
    the PointSpectrum at the given index.
  - getPointSpectrum
```
public PointSpectrum getPointSpectrum(int row,
                                      int col)
```
    Returns the PointSpectrum at the given position.
    
    Parameters:
    
    row - the row (1st) index
    
    col - the column (2nd) index
    
    Returns:
    
    the PointSpectrum at the given position.
  - getPointSpectrumCount
```
public int getPointSpectrumCount()
```
    Returns the number of PointSpectrums present in the container. Same as getSegmentCount()
    
    Specified by:
    
    getPointSpectrumCount in interface Spectral<Double3d>
    
    Returns:
    
    the number of PointSpectrums present in the container.
  - getPointSpectrumIterator
```
public Iterator<PointSpectrum> getPointSpectrumIterator()
```
    Returns a iterator over the PointSpectrums.
    
    Specified by:
    
    getPointSpectrumIterator in interface Spectral<Double3d>
    
    Specified by:
    
    getPointSpectrumIterator in interface SpectrumContainer<Double3d>
    
    Returns:
    
    a iterator over the PointSpectrums.
  - getSelection
```
public List<PointSpectrum> getSelection(SelectionModel selectionModel)
```
    Returns a list of PointSpectrums present in the SelectionModel.
    
    Specified by:
    
    getSelection in interface SpectrumContainer<Double3d>
    
    Parameters:
    
    selectionModel - the model
    
    Returns:
    
    a list of PointSpectrums present in the SelectionModel.
  - getSize
```
public int getSize()
```
    Returns the dimensions of the image [nrow,ncol].
    
    Specified by:
    
    getSize in interface SpectrumContainer<Double3d>
    
    Returns:
    
    the dimensions of the image [nrow,ncol].
  - getPointSpectrumDimension
```
public int[] getPointSpectrumDimension()
```
    Returns the dimensions of the image [nrow,ncol].
    
    Specified by:
    
    getPointSpectrumDimension in interface SpectrumContainer<Double3d>
    
    Returns:
    
    the dimensions of the image [nrow,ncol].
  - getSegmentedNames
```
public Set<String> getSegmentedNames()
```
    Returns the Set of Segmented Attribute names.
    
    Specified by:
    
    getSegmentedNames in interface SpectrumContainer<Double3d>
    
    Returns:
    
    the Set of Segmented Attribute names.
  - getAttributeNames
```
public Set<String> getAttributeNames()
```
    Returns the names of the attributes that can be looked up for all the PointSpectrum's contained in the SpectrumContainer.
    
    Specified by:
    
    getAttributeNames in interface SpectrumContainer<Double3d>
    
    Returns:
    
    the names of the attributes that can be looked up for all the PointSpectrum's contained in the SpectrumContainer.
  - getSegmentIndices
```
public int[] getSegmentIndices()
```
    Returns a list of SpectralSegment indices in the PointSpectrum. NOTE: For now only 0
    
    Specified by:
    
    getSegmentIndices in interface SpectrumContainer<Double3d>
    
    Returns:
    
    a list of SpectralSegment indices in the PointSpectrum.
  - include
```
public boolean include(PointSpectrum spectrum)
```
    Include a PointSpectrum at its own location.
    
    Specified by:
    
    include in interface SpectrumContainer<Double3d>
    
    Parameters:
    
    spectrum - the PointSpectrum
    
    Returns:
    
    succes
  - append
```
public boolean append(PointSpectrum spectrum)
```
    Append a PointSpectrum to the container.
    
    Specified by:
    
    append in interface SpectrumContainer<Double3d>
    
    Parameters:
    
    spectrum - the PointSpectrum
    
    Returns:
    
    succes
  - include
```
public boolean include(PointSpectrum spectrum,
                       int index)
```
    Include a PointSpectrum at a given index.
    
    Specified by:
    
    include in interface SpectrumContainer<Double3d>
    
    Parameters:
    
    spectrum - the PointSpectrum
    
    index - the location where to put it
    
    Returns:
    
    success
  - getOutputTemplate
```
public SpectralSimpleCube getOutputTemplate()
```
    Returns a copy of this container without the attribute objects.
    
    Specified by:
    
    getOutputTemplate in interface SpectrumContainer<Double3d>
    
    Returns:
    
    a copy of this container without the attribute objects.
  - getOutputTemplate
```
public SpectralSimpleCube getOutputTemplate(int[] imageSize)
```
    Returns a container with given imagesize.
    
    Specified by:
    
    getOutputTemplate in interface SpectrumContainer<Double3d>
    
    Parameters:
    
    imageSize - 2-dim resize the image dimensions: [nlat,nlon]
    
    Returns:
    
    a container with given imagesize.
  - getOutputTemplate
```
public SpectralSimpleCube getOutputTemplate(int[] imageSize,
                                            int[] spectralSize)
```
    Returns a container with given imagesize and spectralsize.
    
    Specified by:
    
    getOutputTemplate in interface SpectrumContainer<Double3d>
    
    Parameters:
    
    imageSize - 2-dim resize the image dimensions: [nlat,nlon]
    
    spectralSize - 1-dim resize the spectral dimensions: [nspc]
    
    Returns:
    
    a container with given imagesize and spectralsize.
  - getOutputTemplate
```
public SpectralSimpleCube getOutputTemplate(int[] imageSize,
                                            int[] spectralSize,
                                            int[] segmentIdx)
```
    Returns a container with given imagesize and spectralsize.
    
    Specified by:
    
    getOutputTemplate in interface SpectrumContainer<Double3d>
    
    Parameters:
    
    imageSize - 2-dim resize the image dimensions: [nlat,nlon]
    
    spectralSize - 1-dim resize the spectral dimensions: [nspc]
    
    segmentIdx - has no effect
    
    Returns:
    
    a container with given imagesize and spectralsize.
  - getOutputTemplate
```
public SpectralSimpleCube getOutputTemplate(int size)
```
    Return suitably initialized new instance of the given data structure.
    
    Specified by:
    
    getOutputTemplate in interface SpectrumContainer<Double3d>
    
    Parameters:
    
    size - number of PointSpectrum to be included in the container.
    
    Returns:
    
    suitably initialized new instance of the given data structure.
  - getOutputTemplate
```
public SpectralSimpleCube getOutputTemplate(int size,
                                            int[] segmentShape)
```
    Return suitably initialized new instance of the given data structure.
    
    Specified by:
    
    getOutputTemplate in interface SpectrumContainer<Double3d>
    
    Parameters:
    
    size - number of PointSpectrum to be included in the container.
    
    segmentShape - shape of the sub-segments of PointSpectrum to be included in the container.
    
    Returns:
    
    suitably initialized new instance of the given data structure.
  - getOutputTemplate
```
public SpectralSimpleCube getOutputTemplate(int size,
                                            int[] segmentShape,
                                            int[] segmentIdx)
```
    Return suitably initialized new instance of the given data structure.
    
    Specified by:
    
    getOutputTemplate in interface SpectrumContainer<Double3d>
    
    Parameters:
    
    size - number of PointSpectrum to be included in the container.
    
    segmentShape - shape of the sub-segments of PointSpectrum to be included in the container.
    
    segmentIdx - the indices to be associated with the segments - take default if null.
    
    Returns:
    
    suitably initialized new instance of the given data structure.
  - getUnitInformation
```
public UnitInformation getUnitInformation()
```
    Returns interface that provides access to the unit information of the data included in the container. Note that for containers the segment and attribute data is assumed to have the same units and description for all the point spectra included.
    
    Specified by:
    
    getUnitInformation in interface SpectrumContainer<Double3d>
    
    Specified by:
    
    getUnitInformation in interface UnitInformationHolder
    
    Returns:
    
    interface that provides access to the unit information of the data included in the container.
  - slice2d
```
protected IndexIterator slice2d(int depth,
                                int[] dim)
```
    Returns a 2d slice of a cube at a spectral position.
    
    Parameters:
    
    depth - the spectral slice position
    
    dim - the dimensions of the cube
    
    Returns:
    
    a 2d slice of a cube at a spectral position.
  - slice1d
```
protected IndexIterator slice1d(int row,
                                int col,
                                int[] dim)
```
    Returns a 1d slice of a cube at a image position.
    
    Parameters:
    
    row - the row position
    
    col - the column position
    
    dim - the dimensions of the cube
    
    Returns:
    
    a 1d slice of a cube at a image position.

Class SpectralSimpleCube

Nested Class Summary

Nested classes/interfaces inherited from class herschel.ia.dataset.Product

Field Summary

Fields inherited from class herschel.ia.dataset.image.SimpleCube

Fields inherited from class herschel.ia.dataset.Product

Fields inherited from interface herschel.ia.dataset.spectrum.SpectrumContainer

Fields inherited from interface herschel.ia.dataset.spectrum.Spectral

Constructor Summary

Method Summary

Methods inherited from class herschel.ia.dataset.image.SimpleCube

Methods inherited from class herschel.ia.dataset.Product

Methods inherited from class herschel.ia.dataset.AbstractComposite

Methods inherited from class herschel.ia.dataset.AbstractAnnotatable

Methods inherited from class java.lang.Object

Methods inherited from interface herschel.ia.dataset.spectrum.SpectrumContainer

Methods inherited from interface herschel.ia.dataset.Attributable

Methods inherited from interface herschel.ia.dataset.spectrum.Spectral

Methods inherited from interface java.lang.Iterable

Methods inherited from interface herschel.ia.dataset.image.Cube

Constructor Detail

SpectralSimpleCube

SpectralSimpleCube

SpectralSimpleCube

SpectralSimpleCube

Method Detail

copy

iterator

getRank

getSegmentCount

getSpectralSegmentIterator

getSpectralSegmentIterator

getSpectralSegmentIterator

getSpectralSegment

getSpectralSegment

getSpectralSegment

setColumnFirst

getColumnFirst

getIndex

getRowCol

getSubset

hasSubset

getSubsetCount

getSubsetNames

getPlaneCount

getRowCount

getColumnCount

getSpectrum1d

getFlux

getFlux

getFlux

getFlux

getFlux

getFlux

getFlux

setFlux

setFlux

setFlux

setFlux

getWave

getWave

getWave

getWave

getWave

getWave

setWave

setWave

setWave

setWave

setWave

setWave

hasWeight

hasError

getWeight

getWeight

getWeight

getWeight

getWeight

getWeight

getWeight