QubeDataSetIterator

java.lang.Object
- org.das2.qds.QubeDataSetIterator

All Implemented Interfaces:

DataSetIterator
```
public final class QubeDataSetIterator
extends java.lang.Object
implements DataSetIterator
```
DataSetIterator implementation that can be used for all dataset (not just qubes). Originally this only worked for QDataSets that were qubes, or datasets that had the same dataset geometry for each slice. At some point this was modified to work with any dataset but the name remains. DataSetIterators are intended to work with multiple datasets at once. For example, if we want to add the data from two datasets together, we would create one iterator that would be used to access both datasets. One dataset is provided to the constructor, but any dataset of the same geometry can be passed to the getValue method. TODO: This does not work for Rank 0 datasets. See sftp://klunk.physics.uiowa.edu/home/jbf/project/autoplot/script/demos/jeremy/qubeDataSetIteratorForNonQubes.jy

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`QubeDataSetIterator.DimensionIterator` DimensionIterator iterates over an index.
`static interface`	`QubeDataSetIterator.DimensionIteratorFactory` DimensionIteratorFactory creates DimensionIterators
`static class`	`QubeDataSetIterator.IndexListIterator` Iterator that goes through a list of indices.
`static class`	`QubeDataSetIterator.IndexListIteratorFactory` Factory for iterator that goes through a list of indices.
`static class`	`QubeDataSetIterator.SingletonIterator` Iterator for a single index.
`static class`	`QubeDataSetIterator.SingletonIteratorFactory` Factory for iterator for a single index, which can be negative indicating it is from the end of the array.
`static class`	`QubeDataSetIterator.StartStopStepIterator` Iterator for counting off indices.
`static class`	`QubeDataSetIterator.StartStopStepIteratorFactory` generates iterator for counting off indices.

Constructor Summary

Constructors
Constructor and Description

QubeDataSetIterator(QDataSet ds)
dataset iterator to help in implementing the complex indexing types of python.

Constructors
Constructor and Description
`QubeDataSetIterator(QDataSet ds)` dataset iterator to help in implementing the complex indexing types of python.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`checkValidIndexList(QDataSet ds, int indexSize)`
`DDataSet`	`createEmptyDs()` return a dataset that will have the same geometry at the dataset implied by each dimension iterator.
`static java.lang.String`	`currentJythonLine()` return the current line in the Jython script as <filename>:<linenum> or ??? if this cannot be done.
`QDataSet`	`getRank0Value(QDataSet ds)` get the rank 0 data set the current iterator position.
`double`	`getValue(QDataSet ds)` get the value from ds at the current iterator position.
`boolean`	`hasNext()` true if there are more values.
`int`	`index(int dim)` return the current index for the dimension.
`int`	`length(int dim)` return the length of the dimension, or the length reported by the iterator.
`void`	`next()` advance to the next index.
`void`	`putRank0Value(WritableDataSet ds, QDataSet vds)` replace the value in ds at the current iterator position.
`void`	`putValue(WritableDataSet ds, double v)` replace the value in ds at the current iterator position.
`int`	`rank()` return the rank of the dataset which the iterator will walk through.
`void`	`setIndexIteratorFactory(int dim, QubeDataSetIterator.DimensionIteratorFactory fit)` reinitializes the iterator.
`void`	`setMonitor(ProgressMonitor mon)` convenient method for monitoring long processes, this allows clients to let the iterator manage the monitor.
`static QubeDataSetIterator`	`sliceIterator(QDataSet ds, int sliceIndex)` return an iterator for the slice of a dataset (on the 0th index).
`java.lang.String`	`toString()`

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

- Constructor Detail
  - QubeDataSetIterator
```
public QubeDataSetIterator(QDataSet ds)
```
    dataset iterator to help in implementing the complex indexing types of python. Each of the dimensions is set to iterate over all indices (e.g ds[:,:,:]) Client codes should create a new iterator, set the index iterator factories, then iterate.
    
    Parameters:
    
    ds - the dataset we will iterate over.
- Method Detail
  - currentJythonLine
```
public static java.lang.String currentJythonLine()
```
    return the current line in the Jython script as <filename>:<linenum> or ??? if this cannot be done. Note calls to this will collect a stack trace and will affect performance.
    
    Returns:
    
    the current line or ???
    
    See Also:
    
    JythonOps#currentLine()
  - checkValidIndexList
```
public static void checkValidIndexList(QDataSet ds,
                                       int indexSize)
```
  - setMonitor
```
public void setMonitor(ProgressMonitor mon)
```
    convenient method for monitoring long processes, this allows clients to let the iterator manage the monitor. setTaskSize, started, setTaskProgress, and finished are called automatically. The monitor will reflect the zeroth index.
    
    Parameters:
    
    mon - the monitor, or null.
  - sliceIterator
```
public static QubeDataSetIterator sliceIterator(QDataSet ds,
                                                int sliceIndex)
```
    return an iterator for the slice of a dataset (on the 0th index). This is introduced to improve performance by reducing the number of bounds checks, etc from the general case. Note slice is a native operation for most datasets now, so this is probably obsolete.
    
    Parameters:
    
    ds - the dataset.
    
    sliceIndex - the index of the slice.
    
    Returns:
    
    an iterator for the slice.
    
    See Also:
    
    QDataSet.slice(int)
  - setIndexIteratorFactory
```
public void setIndexIteratorFactory(int dim,
                                    QubeDataSetIterator.DimensionIteratorFactory fit)
```
    reinitializes the iterator.
    
    Parameters:
    
    dim - the dimension index (0,...,rank-1)
    
    fit - the iterator factory to use for the index.
  - hasNext
```
public boolean hasNext()
```
    true if there are more values.
    
    Specified by:
    
    hasNext in interface DataSetIterator
    
    Returns:
    
    true if there are more values.
  - next
```
public void next()
```
    advance to the next index. getValue(ds) will return the value of the dataset at this index.
    
    Specified by:
    
    next in interface DataSetIterator
    
    See Also:
    
    getValue(org.das2.qds.QDataSet)
  - index
```
public int index(int dim)
```
    Description copied from interface: DataSetIterator
    
    return the current index for the dimension.
    
    Specified by:
    
    index in interface DataSetIterator
    
    Parameters:
    
    dim - the dimension number (0<=dim<inputRank)
    
    Returns:
    
    the current index.
  - length
```
public int length(int dim)
```
    Description copied from interface: DataSetIterator
    
    return the length of the dimension, or the length reported by the iterator. Use caution, because this does not imply that the result of the iteration is a qube and does not account for slices. (TODO: does this mean that as we iterate through, the length depends on the current index?)
    
    Specified by:
    
    length in interface DataSetIterator
    
    Parameters:
    
    dim - the dimension number (0<=dim<inputRank)
    
    Returns:
    
    the length of the dimension
  - rank
```
public int rank()
```
    Description copied from interface: DataSetIterator
    
    return the rank of the dataset which the iterator will walk through. Note this needn't be the same rank as the dataset! For example, when QubeDataSetIterator walks through ds[:,0,:], the rank is 2 even though ds is rank 3.
    
    Specified by:
    
    rank in interface DataSetIterator
    
    Returns:
    
    the rank of the dataset which the iterator will walk through.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - createEmptyDs
```
public DDataSet createEmptyDs()
```
    return a dataset that will have the same geometry at the dataset implied by each dimension iterator. This is introduced to encapsulate this dangerous code to here where it could be done correctly. Right now this assumes QUBES. Do not pass the result of this into the putValue of this iterator, the result should have its own iterator. 20101006 jbf: copy dimensional metadata DEPEND_0, etc where possible 20120718 jbf: bugfix with ds[7,16,4,:]. Support BINS.
    
    Specified by:
    
    createEmptyDs in interface DataSetIterator
    
    Returns:
    
    empty dataset with structural properties set.
    
    See Also:
    
    createEmptyDs()
  - getValue
```
public final double getValue(QDataSet ds)
```
    Description copied from interface: DataSetIterator
    
    get the value from ds at the current iterator position.
    
    Specified by:
    
    getValue in interface DataSetIterator
    
    Parameters:
    
    ds - a dataset with compatible geometry as the iterator's geometry.
    
    Returns:
    
    the value of ds at the current iterator position.
  - getRank0Value
```
public final QDataSet getRank0Value(QDataSet ds)
```
    Description copied from interface: DataSetIterator
    
    get the rank 0 data set the current iterator position.
    
    Specified by:
    
    getRank0Value in interface DataSetIterator
    
    Returns:
    
    units
  - putValue
```
public final void putValue(WritableDataSet ds,
                           double v)
```
    Description copied from interface: DataSetIterator
    
    replace the value in ds at the current iterator position.
    
    Specified by:
    
    putValue in interface DataSetIterator
    
    Parameters:
    
    ds - a writable dataset with compatible geometry as the iterator's geometry.
    
    v - the value to insert.
  - putRank0Value
```
public void putRank0Value(WritableDataSet ds,
                          QDataSet vds)
```
    Description copied from interface: DataSetIterator
    
    replace the value in ds at the current iterator position.
    
    Specified by:
    
    putRank0Value in interface DataSetIterator
    
    Parameters:
    
    ds - a writable dataset with compatible geometry as the iterator's geometry.
    
    vds - the rank 0 value to insert

Class QubeDataSetIterator

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

QubeDataSetIterator

Method Detail

currentJythonLine

checkValidIndexList

setMonitor

sliceIterator

setIndexIteratorFactory

hasNext

next

index

length

rank

toString

createEmptyDs

getValue

getRank0Value

putValue

putRank0Value