A B C D E F G H I J L M N O P R S T U W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AccessImpl - Interface in uk.ac.starlink.array
-
Interface for the implementation of read/write access to the pixels of an array.
- AccessMode - Class in uk.ac.starlink.array
-
Access mode identifier.
- allOrders() - Static method in class uk.ac.starlink.array.Order
-
Returns a list of all the known ordering schemes.
- allTypes() - Static method in class uk.ac.starlink.array.Type
-
Returns a list of all the known Types.
- ArrayAccess - Interface in uk.ac.starlink.array
-
Provides methods to read and write pixels from an NDArray.
- ArrayArrayImpl - Class in uk.ac.starlink.array
-
ArrayImpl implementation which wraps a primitive numeric java array.
- ArrayArrayImpl(Object, OrderedNDShape, Number) - Constructor for class uk.ac.starlink.array.ArrayArrayImpl
-
Constructs a new ArrayArrayImpl backed by a given java primitive numeric array.
- ArrayBuilder - Interface in uk.ac.starlink.array
-
Interface for objects which can construct an NDArray from a URL.
- ArrayDescription - Interface in uk.ac.starlink.array
-
Describes the basic characteristics of an N-dimensional array.
- arrayDims - Variable in class uk.ac.starlink.array.DefaultArrayDescription
-
Array dimensions; equal to
arrayShape.getDims()
. - arrayHandler - Variable in class uk.ac.starlink.array.DefaultArrayDescription
-
The array bad value handler as returned by the getBadHandler method.
- arrayHandler(Object) - Method in class uk.ac.starlink.array.BadHandler
-
Returns an ArrayHandler object for testing/setting bad values in a given primitive array according to the bad value handling rules of this BadHandler.
- ArrayImpl - Interface in uk.ac.starlink.array
-
Interface for implementation end of the NDArray Bridge pattern.
- arrayIsRandom - Variable in class uk.ac.starlink.array.DefaultArrayDescription
-
The array random access availability as returned by the isRandom method.
- arrayIsReadable - Variable in class uk.ac.starlink.array.DefaultArrayDescription
-
The array readability as returned by the isReadable method.
- arrayIsWritable - Variable in class uk.ac.starlink.array.DefaultArrayDescription
-
The array writability as returned by teh isWritable method.
- arrayNdim - Variable in class uk.ac.starlink.array.DefaultArrayDescription
-
Number of dimensions; equal to
arrayShape.getNumDims()
. - arrayNpix - Variable in class uk.ac.starlink.array.DefaultArrayDescription
-
Number of pixels; equal to
arrayShape.getNumPixels()
. - arrayOrder - Variable in class uk.ac.starlink.array.DefaultArrayDescription
-
Pixel ordering scheme; equal to
arrayShape.getOrder()
. - arrayOrigin - Variable in class uk.ac.starlink.array.DefaultArrayDescription
-
Array origin; equal to
arrayShape.getOrigin()
. - arrayShape - Variable in class uk.ac.starlink.array.DefaultArrayDescription
-
The array shape as returned by the getShape method.
- arrayType - Variable in class uk.ac.starlink.array.DefaultArrayDescription
-
The array type as returned by the getType method.
B
- BadHandler - Class in uk.ac.starlink.array
-
Handles bad pixel values.
- BadHandler(Type, Number) - Constructor for class uk.ac.starlink.array.BadHandler
-
Constructor which may be used for subclassing.
- BadHandler.ArrayHandler - Interface in uk.ac.starlink.array
-
Class provided for testing and setting bad values in a given primitive array.
- BridgeNDArray - Class in uk.ac.starlink.array
- BridgeNDArray(ArrayImpl) - Constructor for class uk.ac.starlink.array.BridgeNDArray
-
Constructs a non-persistent BridgeNDArray (one without a URL) from an ArrayImpl.
- BridgeNDArray(ArrayImpl, URL) - Constructor for class uk.ac.starlink.array.BridgeNDArray
-
Constructs a BridgeNDArray from an ArrayImpl with a given URL.
- BufferIterator - Class in uk.ac.starlink.array
-
Provides buffers for convenient stepping through an array.
- BufferIterator(long) - Constructor for class uk.ac.starlink.array.BufferIterator
-
Create a new BufferIterator with a default chunk size.
- BufferIterator(long, Type, int) - Constructor for class uk.ac.starlink.array.BufferIterator
-
Create a new BufferIterator with a given chunk size.
- BYTE - Static variable in class uk.ac.starlink.array.Type
-
Object representing primitive data of
byte
type.
C
- canMap() - Method in class uk.ac.starlink.array.ArrayArrayImpl
- canMap() - Method in interface uk.ac.starlink.array.ArrayImpl
-
Indicates whether mapped access is available.
- canMap() - Method in class uk.ac.starlink.array.CombineArrayImpl
- canMap() - Method in class uk.ac.starlink.array.DeterministicArrayImpl
- canMap() - Method in class uk.ac.starlink.array.NioArrayImpl
- canMap() - Method in class uk.ac.starlink.array.WrapperArrayImpl
- checkArray(Object, int) - Method in class uk.ac.starlink.array.Type
-
Checks that a given Object is in fact an array of the primitive type corresponding to this Type, and contains at least a given number of elements; throws an exception if not.
- checkOpen() - Method in class uk.ac.starlink.array.DefaultArrayAccess
- ChunkStepper - Class in uk.ac.starlink.array
-
Allows convenient stepping through an array.
- ChunkStepper(long) - Constructor for class uk.ac.starlink.array.ChunkStepper
-
Create a new ChunkStepper with the default chunk size.
- ChunkStepper(long, int) - Constructor for class uk.ac.starlink.array.ChunkStepper
-
Create a new ChunkStepper with a given chunk size.
- clone() - Method in class uk.ac.starlink.array.NDShape
- clone() - Method in class uk.ac.starlink.array.OrderedNDShape
- clone() - Method in class uk.ac.starlink.array.Requirements
-
Provides a snapshot of this object; modifying the returned object will not affect the object from which it was cloned.
- close() - Method in interface uk.ac.starlink.array.AccessImpl
-
This method will be called when read/write access to this object is no longer required.
- close() - Method in interface uk.ac.starlink.array.ArrayAccess
-
Shuts down this accessor for further data access.
- close() - Method in class uk.ac.starlink.array.ArrayArrayImpl
- close() - Method in interface uk.ac.starlink.array.ArrayImpl
-
Shuts down this ArrayImpl for pixel access.
- close() - Method in class uk.ac.starlink.array.BridgeNDArray
- close() - Method in class uk.ac.starlink.array.CombineArrayImpl
- close() - Method in class uk.ac.starlink.array.CopyNDArray
- close() - Method in class uk.ac.starlink.array.DefaultArrayAccess
- close() - Method in class uk.ac.starlink.array.DeterministicArrayImpl
- close() - Method in interface uk.ac.starlink.array.NDArray
-
Declares that this NDArray will not be required for further use; in particular that no further invocations will be made of the getAccess method.
- close() - Method in class uk.ac.starlink.array.NioArrayImpl
- close() - Method in class uk.ac.starlink.array.WrapperArrayImpl
- COLUMN_MAJOR - Static variable in class uk.ac.starlink.array.Order
-
Object representing column-major (first-index-fastest) ordering.
- combination(double, double) - Method in interface uk.ac.starlink.array.Combiner
-
The function of two variables.
- CombineArrayImpl - Class in uk.ac.starlink.array
-
Virtual NDArray implementation combining two given NDArrays using an arbitrary arithmetic function.
- CombineArrayImpl(NDArray, NDArray, Combiner, NDShape, Type, BadHandler) - Constructor for class uk.ac.starlink.array.CombineArrayImpl
-
Construct a new CombineArrayImpl based on two underlying NDArrays and a combiner object.
- Combiner - Interface in uk.ac.starlink.array
-
Defines a real function of two real variables.
- convert12(Object, int, Object, int, int) - Method in interface uk.ac.starlink.array.Converter
-
Converts a sequence of values of type 1 to a sequence of values of type 2.
- convert12(Object, int, Object, int, int) - Method in class uk.ac.starlink.array.TypeConverter
-
Converts a sequence of elements in an array of type 1 and places the results in a sequence of elements in an array of type 2.
- convert21(Object, int, Object, int, int) - Method in interface uk.ac.starlink.array.Converter
-
Converts a sequence of values of type 2 to a sequence of values of type 1.
- convert21(Object, int, Object, int, int) - Method in class uk.ac.starlink.array.TypeConverter
-
Converts a sequence of elements in an array of type 2 and places the results in a sequence of elements in an array of type 1.
- ConvertArrayImpl - Class in uk.ac.starlink.array
-
Wraps an NDArray to produce a virtual NDArray whose pixels are modified using a Converter object.
- ConvertArrayImpl(NDArray, Converter) - Constructor for class uk.ac.starlink.array.ConvertArrayImpl
-
Constructs a new ArrayImpl from an underlying NDArray and a supplied converter object.
- Converter - Interface in uk.ac.starlink.array
-
Converts values between primitive types.
- copy(NDArray, NDArray) - Static method in class uk.ac.starlink.array.NDArrays
-
Copies the data from one NDArray into another.
- CopyNDArray - Class in uk.ac.starlink.array
-
Provides a copy of an existing NDArray with its data backed by a fast random-access scratch array in memory or on local disk.
- CopyNDArray(NDArray, AccessMode) - Constructor for class uk.ac.starlink.array.CopyNDArray
-
Constructs a new NDArray containing the same data as a given one,
D
- DEFAULT_ORIGIN - Static variable in class uk.ac.starlink.array.NDShape
-
The default value of the origin in each dimension; its value is 1.
- DefaultArrayAccess - Class in uk.ac.starlink.array
-
Default implementation of the ArrayAccess interface, based on an AccessImpl.
- DefaultArrayAccess(ArrayDescription, AccessImpl, Object) - Constructor for class uk.ac.starlink.array.DefaultArrayAccess
-
Constructs an ArrayAccess object from a description of the array's characteristics and a basic implementation of pixel access functionality.
- DefaultArrayDescription - Class in uk.ac.starlink.array
-
Straightforward immutable implementation of the ArrayDescription interface.
- DefaultArrayDescription(ArrayDescription) - Constructor for class uk.ac.starlink.array.DefaultArrayDescription
-
Constructs an ArrayDescription object with attributes copied from an existing one.
- DefaultArrayDescription(ArrayDescription, Requirements) - Constructor for class uk.ac.starlink.array.DefaultArrayDescription
-
Constructs an ArrayDescription object with attributes copied from an existing one except as overridden by the requirements of a Requirements object.
- DefaultArrayDescription(OrderedNDShape, Type, BadHandler, boolean, boolean, boolean) - Constructor for class uk.ac.starlink.array.DefaultArrayDescription
-
Constructs an ArrayDescription object with all its attributes specified explicitly.
- defaultBadHandler() - Method in class uk.ac.starlink.array.Type
-
Returns a default bad value handler for this type.
- defaultBadValue() - Method in class uk.ac.starlink.array.Type
-
Returns the default bad value used for this type.
- defaultChunkSize - Static variable in class uk.ac.starlink.array.ChunkStepper
-
The default size of chunks if not otherwise specified.
- DeterministicArrayImpl - Class in uk.ac.starlink.array
-
Toy ArrayImpl implementation not backed by real data.
- DeterministicArrayImpl(NDShape, Type) - Constructor for class uk.ac.starlink.array.DeterministicArrayImpl
-
Constructs a DeterministicArrayImpl of the given type and shape.
- DIRECT - Static variable in class uk.ac.starlink.array.ScratchNDArray.BackingStore
- doClose() - Method in class uk.ac.starlink.array.DefaultArrayAccess
- DOUBLE - Static variable in class uk.ac.starlink.array.Type
-
Object representing primitive data of
double
type. - DummyNDArray - Class in uk.ac.starlink.array
-
NDArray backed by no data.
- DummyNDArray(NDArray) - Constructor for class uk.ac.starlink.array.DummyNDArray
-
Constructs a new DummyNDArray with the same characteristics (pixel sequence, type and bad value handler) as a template NDArray.
- DummyNDArray(NDShape, Type) - Constructor for class uk.ac.starlink.array.DummyNDArray
-
Constructs a new DummyNDArray with a given shape and type and default pixel sequence and bad value.
- DummyNDArray(OrderedNDShape, Type, BadHandler) - Constructor for class uk.ac.starlink.array.DummyNDArray
-
Constructs a new DummyNDArray with a given shape and type and bad value handler.
E
- equals(Object) - Method in class uk.ac.starlink.array.BadHandler
- equals(Object) - Method in class uk.ac.starlink.array.NDShape
- equals(Object) - Method in class uk.ac.starlink.array.OrderedNDShape
-
Indicates whether another object is equivalent to this one.
- equals(NDArray, NDArray) - Static method in class uk.ac.starlink.array.NDArrays
-
Tests two NDArrays for equivalence.
F
- FLOAT - Static variable in class uk.ac.starlink.array.Type
-
Object representing primitive data of
float
type. - forward(double) - Method in interface uk.ac.starlink.array.Function
-
The forward function.
- fromString(String) - Static method in class uk.ac.starlink.array.NDShape
-
Turns a string specification of a shape into an NDShape object.
- Function - Interface in uk.ac.starlink.array
-
Defines a real function of a real variable y=f(x) and its inverse.
G
- getAccess() - Method in class uk.ac.starlink.array.ArrayArrayImpl
- getAccess() - Method in interface uk.ac.starlink.array.ArrayImpl
-
Returns an object which can access the pixels of this ArrayImpl.
- getAccess() - Method in class uk.ac.starlink.array.BridgeNDArray
- getAccess() - Method in class uk.ac.starlink.array.CombineArrayImpl
- getAccess() - Method in class uk.ac.starlink.array.ConvertArrayImpl
- getAccess() - Method in class uk.ac.starlink.array.DeterministicArrayImpl
- getAccess() - Method in interface uk.ac.starlink.array.NDArray
-
Returns an object which can read and/or write the pixels of this NDArray.
- getAccess() - Method in class uk.ac.starlink.array.NioArrayImpl
- getAccess() - Method in class uk.ac.starlink.array.PixelMapArrayImpl
- getAccess() - Method in class uk.ac.starlink.array.WindowArrayImpl
- getAccess() - Method in class uk.ac.starlink.array.WrapperArrayImpl
- getBadHandler() - Method in interface uk.ac.starlink.array.ArrayDescription
-
Gets an object capable of handling bad pixel values for this array.
- getBadHandler() - Method in class uk.ac.starlink.array.DefaultArrayDescription
- getBadHandler() - Method in class uk.ac.starlink.array.Requirements
-
Gets this object's required bad value handler.
- getBadHandler() - Method in class uk.ac.starlink.array.WindowArrayImpl
- getBadHandler1() - Method in interface uk.ac.starlink.array.Converter
-
Returns the bad value handler used for type 1.
- getBadHandler1() - Method in class uk.ac.starlink.array.TypeConverter
-
Gets the bad value handler for end 1 of the converter.
- getBadHandler2() - Method in interface uk.ac.starlink.array.Converter
-
Returns the bad value handler used for type 2.
- getBadHandler2() - Method in class uk.ac.starlink.array.TypeConverter
-
Gets the bad value handler for end 2 of the converter.
- getBadValue() - Method in class uk.ac.starlink.array.ArrayArrayImpl
- getBadValue() - Method in interface uk.ac.starlink.array.ArrayImpl
-
The magic bad value for data.
- getBadValue() - Method in class uk.ac.starlink.array.BadHandler
-
Gets the bad data value.
- getBadValue() - Method in class uk.ac.starlink.array.CombineArrayImpl
- getBadValue() - Method in class uk.ac.starlink.array.ConvertArrayImpl
- getBadValue() - Method in class uk.ac.starlink.array.DeterministicArrayImpl
- getBadValue() - Method in class uk.ac.starlink.array.NioArrayImpl
- getBadValue() - Method in class uk.ac.starlink.array.WrapperArrayImpl
- getBase() - Method in class uk.ac.starlink.array.BufferIterator
-
The offset of the base of the chunk most recently returned by next.
- getBase() - Method in class uk.ac.starlink.array.ChunkStepper
-
The offset of the base of the current chunk.
- getBuffer() - Method in interface uk.ac.starlink.array.NioArrayImpl.BufferGetter
-
Returns an NIO buffer.
- getBuilders() - Method in class uk.ac.starlink.array.NDArrayFactory
-
Gets the list of builders which actually do the URL->NDArray construction.
- getDims() - Method in class uk.ac.starlink.array.NDShape
-
Returns the extents in each dimension of the NDShape.
- getHandler(Type, Number) - Static method in class uk.ac.starlink.array.BadHandler
-
Returns an instance of this class capable of dealing with primitives of a given type and using a given bad value.
- getImpl() - Method in class uk.ac.starlink.array.BridgeNDArray
-
Returns the ArrayImpl object supplying the implementation for this BridgeNDArray.
- getLimits() - Method in class uk.ac.starlink.array.NDShape
-
Returns the exclusive upper limits in each dimension of the NDShape.
- getMapped() - Method in interface uk.ac.starlink.array.ArrayAccess
-
Returns a single primitive array holding all the data of this array.
- getMapped() - Method in class uk.ac.starlink.array.ArrayArrayImpl
- getMapped() - Method in interface uk.ac.starlink.array.ArrayImpl
-
Returns a single primitive array holding all the pixel data of this array.
- getMapped() - Method in class uk.ac.starlink.array.CombineArrayImpl
- getMapped() - Method in class uk.ac.starlink.array.DefaultArrayAccess
- getMapped() - Method in class uk.ac.starlink.array.DeterministicArrayImpl
- getMapped() - Method in class uk.ac.starlink.array.NioArrayImpl
- getMapped() - Method in class uk.ac.starlink.array.WrapperArrayImpl
- getMode() - Method in class uk.ac.starlink.array.Requirements
-
Gets an object indicating the use to which the required array will be put.
- getNumBytes() - Method in class uk.ac.starlink.array.Type
-
Returns the number of bytes occupied by this primitive type.
- getNumDims() - Method in class uk.ac.starlink.array.NDShape
-
Returns the dimensionality of the NDShape.
- getNumPixels() - Method in class uk.ac.starlink.array.NDShape
-
Returns the number of cells in the array represented by this NDShape.
- getOffset() - Method in interface uk.ac.starlink.array.ArrayAccess
-
Returns the current offset into the array for read/write.
- getOffset() - Method in class uk.ac.starlink.array.DefaultArrayAccess
- getOrder() - Method in class uk.ac.starlink.array.OrderedNDShape
-
Gets the ordering scheme of this object.
- getOrder() - Method in class uk.ac.starlink.array.Requirements
-
Gets this object's required pixel ordering scheme.
- getOrigin() - Method in class uk.ac.starlink.array.NDShape
-
Returns the origin in each dimension of the NDShape.
- getPosition() - Method in interface uk.ac.starlink.array.ArrayAccess
-
Returns the coordinates at which the next read/write will occur.
- getPosition() - Method in class uk.ac.starlink.array.DefaultArrayAccess
- getRandom() - Method in class uk.ac.starlink.array.Requirements
-
Gets a flag indicating whether random access is required.
- getShape() - Method in class uk.ac.starlink.array.ArrayArrayImpl
- getShape() - Method in interface uk.ac.starlink.array.ArrayDescription
-
Gets the OrderedNDShape object which describes the origin, dimensions and pixel ordering scheme of this array.
- getShape() - Method in interface uk.ac.starlink.array.ArrayImpl
-
Returns an object representing the shape (origin and dimensions) and pixel sequence of this object.
- getShape() - Method in class uk.ac.starlink.array.CombineArrayImpl
- getShape() - Method in class uk.ac.starlink.array.DefaultArrayDescription
- getShape() - Method in class uk.ac.starlink.array.DeterministicArrayImpl
- getShape() - Method in class uk.ac.starlink.array.MouldArrayImpl
- getShape() - Method in class uk.ac.starlink.array.NioArrayImpl
- getShape() - Method in class uk.ac.starlink.array.PixelMapArrayImpl
- getShape() - Method in class uk.ac.starlink.array.WindowArrayImpl
- getShape() - Method in class uk.ac.starlink.array.WrapperArrayImpl
- getSize() - Method in class uk.ac.starlink.array.ChunkStepper
-
Get the size of the current chunk.
- getTotalLength() - Method in class uk.ac.starlink.array.ChunkStepper
-
Returns the length of this ChunkStepper as supplied to the constructor - the total number of elements over which it will iterate.
- getType() - Method in class uk.ac.starlink.array.ArrayArrayImpl
- getType() - Method in interface uk.ac.starlink.array.ArrayDescription
-
Returns the type of the primitive data in this array.
- getType() - Method in interface uk.ac.starlink.array.ArrayImpl
-
Returns the primitive type of the data held by this object.
- getType() - Method in class uk.ac.starlink.array.BadHandler
-
Gets the Type of this handler.
- getType() - Method in class uk.ac.starlink.array.CombineArrayImpl
- getType() - Method in class uk.ac.starlink.array.ConvertArrayImpl
- getType() - Method in class uk.ac.starlink.array.DefaultArrayDescription
- getType() - Method in class uk.ac.starlink.array.DeterministicArrayImpl
- getType() - Method in class uk.ac.starlink.array.NioArrayImpl
- getType() - Method in class uk.ac.starlink.array.Requirements
-
Gets this object's required data type.
- getType() - Method in class uk.ac.starlink.array.WrapperArrayImpl
- getType(Class) - Static method in class uk.ac.starlink.array.Type
-
Returns the Type object corresponding to a given java class.
- getType1() - Method in interface uk.ac.starlink.array.Converter
-
Returns the data type of type 1.
- getType1() - Method in class uk.ac.starlink.array.TypeConverter
-
Gets the primitive type for end 1 of the converter.
- getType2() - Method in interface uk.ac.starlink.array.Converter
-
Returns the data type of type 2.
- getType2() - Method in class uk.ac.starlink.array.TypeConverter
-
Gets the primitive type for end 2 of the converter.
- getUpperBounds() - Method in class uk.ac.starlink.array.NDShape
-
Returns the inclusive upper limits in each dimension of the NDShape.
- getURL() - Method in class uk.ac.starlink.array.BridgeNDArray
- getURL() - Method in class uk.ac.starlink.array.CopyNDArray
- getURL() - Method in interface uk.ac.starlink.array.NDArray
-
Returns the URL of this NDArray, or null if it does not have one.
- getWindow() - Method in class uk.ac.starlink.array.Requirements
-
Gets this object's required window; the shape it must have.
- getWrapped() - Method in class uk.ac.starlink.array.WrapperArrayImpl
-
Returns the NDArray which this Wrapper is wrapping.
H
- hashCode() - Method in class uk.ac.starlink.array.BadHandler
- hashCode() - Method in class uk.ac.starlink.array.NDShape
- hashCode() - Method in class uk.ac.starlink.array.OrderedNDShape
- hasNext() - Method in class uk.ac.starlink.array.BufferIterator
-
See if iteration has finished.
- hasNext() - Method in class uk.ac.starlink.array.ChunkStepper
-
See if iteration has finished.
I
- INT - Static variable in class uk.ac.starlink.array.Type
-
Object representing primitive data of
int
type. - intersection(NDShape) - Method in class uk.ac.starlink.array.NDShape
-
Returns a NDShape giving the intersection between this shape and another one.
- intsToLongs(int[]) - Static method in class uk.ac.starlink.array.NDShape
-
Convenience method for converting an array of int values to an array of long values.
- inverse(double) - Method in interface uk.ac.starlink.array.Function
-
The inverse function.
- isBad(int) - Method in interface uk.ac.starlink.array.BadHandler.ArrayHandler
-
Indicates whether an element of this ArrayHandler's primitive array is bad.
- isBad(Object, int) - Method in class uk.ac.starlink.array.BadHandler
-
Indicates whether an element of an array represents a bad value for this NDArray.
- isFitsLike() - Method in class uk.ac.starlink.array.Order
-
Convenience method which returns true for ordering which is FITS-like and Fortran-like (that is for COLUMN_MAJOR), otherwise false.
- isFloating() - Method in class uk.ac.starlink.array.Type
-
Indicates whether this type represents floating point values.
- isMapped() - Method in interface uk.ac.starlink.array.ArrayAccess
-
Indicates whether mapped access is available.
- isMapped() - Method in class uk.ac.starlink.array.DefaultArrayAccess
- isRandom() - Method in class uk.ac.starlink.array.ArrayArrayImpl
- isRandom() - Method in interface uk.ac.starlink.array.ArrayDescription
-
Indicates whether random access is available.
- isRandom() - Method in interface uk.ac.starlink.array.ArrayImpl
-
Indicates whether random access is possible.
- isRandom() - Method in class uk.ac.starlink.array.CombineArrayImpl
- isRandom() - Method in class uk.ac.starlink.array.DefaultArrayDescription
- isRandom() - Method in class uk.ac.starlink.array.DeterministicArrayImpl
- isRandom() - Method in class uk.ac.starlink.array.NioArrayImpl
- isRandom() - Method in class uk.ac.starlink.array.WrapperArrayImpl
- isReadable() - Method in class uk.ac.starlink.array.AccessMode
-
Indicates whether this mode includes read access.
- isReadable() - Method in class uk.ac.starlink.array.ArrayArrayImpl
- isReadable() - Method in interface uk.ac.starlink.array.ArrayDescription
-
Indicates whether the pixels of this array may be read.
- isReadable() - Method in interface uk.ac.starlink.array.ArrayImpl
-
Indicates whether read access is possible.
- isReadable() - Method in class uk.ac.starlink.array.CombineArrayImpl
- isReadable() - Method in class uk.ac.starlink.array.DefaultArrayDescription
- isReadable() - Method in class uk.ac.starlink.array.DeterministicArrayImpl
- isReadable() - Method in class uk.ac.starlink.array.NioArrayImpl
- isReadable() - Method in class uk.ac.starlink.array.WrapperArrayImpl
- isReadOnly() - Method in interface uk.ac.starlink.array.NioArrayImpl.BufferGetter
-
Indicates whether the buffer, when created, will be read-only or not.
- isUnit12() - Method in interface uk.ac.starlink.array.Converter
-
Indicates whether conversion from type 1 to type 2 does any work.
- isUnit12() - Method in class uk.ac.starlink.array.TypeConverter
-
Indicates whether the conversion from type 1 to type 2 is known to be a unit transformation.
- isUnit21() - Method in interface uk.ac.starlink.array.Converter
-
Indicates whether conversion from type 2 to type 1 does any work.
- isUnit21() - Method in class uk.ac.starlink.array.TypeConverter
-
Indicates whether the conversion from type 2 to type 1 is known to be a unit transformation.
- isWritable() - Method in class uk.ac.starlink.array.AccessMode
-
Indicates whether this mode includes write access.
- isWritable() - Method in class uk.ac.starlink.array.ArrayArrayImpl
- isWritable() - Method in interface uk.ac.starlink.array.ArrayDescription
-
Indicates whether the pixels of this array may be written.
- isWritable() - Method in interface uk.ac.starlink.array.ArrayImpl
-
Indicates whether write access is possible.
- isWritable() - Method in class uk.ac.starlink.array.CombineArrayImpl
- isWritable() - Method in class uk.ac.starlink.array.DefaultArrayDescription
- isWritable() - Method in class uk.ac.starlink.array.DeterministicArrayImpl
- isWritable() - Method in class uk.ac.starlink.array.NioArrayImpl
- isWritable() - Method in class uk.ac.starlink.array.WrapperArrayImpl
J
- javaClass() - Method in class uk.ac.starlink.array.Type
-
Returns the java primitive class associated with this type.
L
- longsToInts(long[]) - Static method in class uk.ac.starlink.array.NDShape
-
Convenience method for converting an array of long values to an array of int values.
M
- makeNDArray(String, AccessMode) - Method in class uk.ac.starlink.array.NDArrayFactory
-
Constructs a readable NDArray from a location representing an existing resource.
- makeNDArray(URL, AccessMode) - Method in interface uk.ac.starlink.array.ArrayBuilder
-
Constructs an NDArray based on the existing resource at a given URL.
- makeNDArray(URL, AccessMode) - Method in class uk.ac.starlink.array.NDArrayFactory
-
Constructs a readable NDArray from a URL representing an exisiting resource.
- makeNewNDArray(String, NDArray) - Method in class uk.ac.starlink.array.NDArrayFactory
-
Constructs a new NDArray to which data can be written given a location and another template NDArray.
- makeNewNDArray(String, NDShape, Type, BadHandler) - Method in class uk.ac.starlink.array.NDArrayFactory
-
Constructs a new NDArray to which data can be written given a location and the array characteristics.
- makeNewNDArray(URL, NDArray) - Method in class uk.ac.starlink.array.NDArrayFactory
-
Constructs a new NDArray to which data can be written given a URL and another template NDArray.
- makeNewNDArray(URL, NDShape, Type, BadHandler) - Method in interface uk.ac.starlink.array.ArrayBuilder
-
Constructs a new NDArray with the given characteristics in a location determined by a given URL.
- makeNewNDArray(URL, NDShape, Type, BadHandler) - Method in class uk.ac.starlink.array.NDArrayFactory
-
Constructs a new NDArray to which data can be written given a URL and the array characteristics.
- makeNumber(Object, int) - Method in class uk.ac.starlink.array.BadHandler
-
Turns a single element of an array into a
Number
object of the appropriate type. - mapOffset(long) - Method in interface uk.ac.starlink.array.OffsetMapper
-
Returns an offset into array 2 corresponding to a given offset in array 1.
- mapOffset(long) - Method in class uk.ac.starlink.array.OrderedShapeMapper
- mapOffset(long) - Method in class uk.ac.starlink.array.ReorderingMapper
- mapRange(long[]) - Method in interface uk.ac.starlink.array.OffsetMapper
-
Returns a two-element array (min,max) indicating the range of mapping output values (array 2 offsets) which correspond to a given range of input values (array 1 offsets).
- mapRange(long[]) - Method in class uk.ac.starlink.array.OrderedShapeMapper
- mapRange(long[]) - Method in class uk.ac.starlink.array.ReorderingMapper
- maximumValue() - Method in class uk.ac.starlink.array.Type
-
Returns the highest value which can be represented by this type.
- MEMORY - Static variable in class uk.ac.starlink.array.ScratchNDArray.BackingStore
- minimumValue() - Method in class uk.ac.starlink.array.Type
-
Returns the lowest (= most negative) value which can be represented by this type.
- MouldArrayImpl - Class in uk.ac.starlink.array
-
Wraps an NDArray to provide one with identical pixel data, but viewed as a different shape, that is with its origin or dimensions different.
- MouldArrayImpl(NDArray, NDShape) - Constructor for class uk.ac.starlink.array.MouldArrayImpl
-
Creates a new ArrayImpl which which uses the pixels from an underlying NDArray moulded into a different shape (origin/dimensions).
- multipleAccess() - Method in class uk.ac.starlink.array.ArrayArrayImpl
- multipleAccess() - Method in interface uk.ac.starlink.array.ArrayImpl
-
Indicates whether the getAccess method may be called more than once.
- multipleAccess() - Method in class uk.ac.starlink.array.BridgeNDArray
- multipleAccess() - Method in class uk.ac.starlink.array.CombineArrayImpl
- multipleAccess() - Method in class uk.ac.starlink.array.DeterministicArrayImpl
- multipleAccess() - Method in interface uk.ac.starlink.array.NDArray
-
Indicates whether multiple calls to the getAccess method may be made.
- multipleAccess() - Method in class uk.ac.starlink.array.NioArrayImpl
- multipleAccess() - Method in class uk.ac.starlink.array.WrapperArrayImpl
N
- NDArray - Interface in uk.ac.starlink.array
-
N-dimensional array access.
- NDArrayFactory - Class in uk.ac.starlink.array
-
Manufactures NDArray objects from URLs.
- NDArrayFactory() - Constructor for class uk.ac.starlink.array.NDArrayFactory
-
Constructs an NDArrayFactory with a default list of builders.
- NDArrays - Class in uk.ac.starlink.array
-
Utility methods for NDArray manipulation.
- NDShape - Class in uk.ac.starlink.array
-
Represents the shape of an N-dimensional rectangular array.
- NDShape(int[]) - Constructor for class uk.ac.starlink.array.NDShape
-
Creates an NDShape object with a default origin from an integer array of dimensions.
- NDShape(long[]) - Constructor for class uk.ac.starlink.array.NDShape
-
Creates an NDShape object with a default origin from its dimensions.
- NDShape(long[], int[]) - Constructor for class uk.ac.starlink.array.NDShape
-
Creates an NDShape object from its origin and an integer array of dimensions.
- NDShape(long[], long[]) - Constructor for class uk.ac.starlink.array.NDShape
-
Creates an NDShape object from its origin and dimensions.
- NDShape(NDShape) - Constructor for class uk.ac.starlink.array.NDShape
-
Creates an NDShape object with the same origin and dimensions as an existing one.
- newArray(int) - Method in class uk.ac.starlink.array.Type
-
Constructs a new primitive array of a requested size and the appropriate type for this object.
- next() - Method in class uk.ac.starlink.array.BufferIterator
-
Returns a primitive buffer of this object's type, with a length matching that of this chunk.
- next() - Method in class uk.ac.starlink.array.ChunkStepper
-
Iterates to the next chunk.
- NioArrayImpl - Class in uk.ac.starlink.array
-
Implementation of ArrayImpl which uses a
Buffer
for the data storage. - NioArrayImpl(Buffer, OrderedNDShape, Type, Number) - Constructor for class uk.ac.starlink.array.NioArrayImpl
-
Constructs an ArrayImpl from a
Buffer
. - NioArrayImpl(NioArrayImpl.BufferGetter, OrderedNDShape, Type, Number) - Constructor for class uk.ac.starlink.array.NioArrayImpl
-
Constructs an ArrayImpl using a deferred-access buffer object.
- NioArrayImpl.BufferGetter - Interface in uk.ac.starlink.array
-
Defines an object which can provide deferred access to a
Buffer
.
O
- OffsetMapper - Interface in uk.ac.starlink.array
-
Defines a mapping of pixel offsets in one array to their offsets in another array.
- offsetToPosition(long) - Method in class uk.ac.starlink.array.OrderedNDShape
-
Determines the coordinates of a pixel at a given offset within the pixel sequence.
- offsetToValue(long) - Method in class uk.ac.starlink.array.DeterministicArrayImpl
-
Maps the array offset to the value at that offset.
- open() - Method in class uk.ac.starlink.array.ArrayArrayImpl
- open() - Method in interface uk.ac.starlink.array.ArrayImpl
-
Prepares this ArrayImpl for pixel access.
- open() - Method in class uk.ac.starlink.array.CombineArrayImpl
- open() - Method in class uk.ac.starlink.array.DeterministicArrayImpl
- open() - Method in class uk.ac.starlink.array.NioArrayImpl
- open() - Method in class uk.ac.starlink.array.WrapperArrayImpl
- Order - Class in uk.ac.starlink.array
-
Pixel ordering identifier.
- OrderedNDShape - Class in uk.ac.starlink.array
-
Represents the arrangement of pixels within an N-dimensional array.
- OrderedNDShape(long[], long[], Order) - Constructor for class uk.ac.starlink.array.OrderedNDShape
-
Creates an OrderedNDShape from its origin, dimensions and ordering.
- OrderedNDShape(long[], Order) - Constructor for class uk.ac.starlink.array.OrderedNDShape
-
Creates an OrderedNDShape with a default origin from its dimensions and ordering.
- OrderedNDShape(NDShape) - Constructor for class uk.ac.starlink.array.OrderedNDShape
-
Creates a new OrderedNDShape from an NDShape.
- OrderedNDShape(NDShape, Order) - Constructor for class uk.ac.starlink.array.OrderedNDShape
-
Creates an OrderedNDShape from a NDShape and an ordering.
- OrderedShapeMapper - Class in uk.ac.starlink.array
-
Implements the OffsetMapper interface to map between arrays with different shapes and/or ordering schemes.
- OrderedShapeMapper(OrderedNDShape, OrderedNDShape) - Constructor for class uk.ac.starlink.array.OrderedShapeMapper
-
Constructs an OffsetMapper which maps between two arrays with different pixel sequences.
P
- pixelIterator() - Method in class uk.ac.starlink.array.OrderedNDShape
-
Returns an Iterator which will iterate over all the pixels in this OrderedNDShape's pixel sequence.
- pixelIterator(long, long) - Method in class uk.ac.starlink.array.OrderedNDShape
-
Returns an Iterator which will iterate over a range of pixels in this OrderedNDShape's pixel sequence.
- PixelMapArrayImpl - Class in uk.ac.starlink.array
-
Wraps an NDArray to produce a virtual ArrayImpl in which each pixel is the same as a pixel of the base array, but in a different order.
- PixelMapArrayImpl(NDArray, OrderedNDShape, OffsetMapper) - Constructor for class uk.ac.starlink.array.PixelMapArrayImpl
-
Constructs a new ArrayImpl from a base NDArray and an OffsetMapper object which transforms the offset of a pixel in the base array to the offset of the same pixel in this PixelMapArrayImpl.
- positionToOffset(long[]) - Method in class uk.ac.starlink.array.OrderedNDShape
-
Returns the offset of a pixel having given coordinates within the sequence of pixels defined by this OrderedNDShape.
- putBad(int) - Method in interface uk.ac.starlink.array.BadHandler.ArrayHandler
-
Writes a single bad value into this ArrayHandler's array.
- putBad(Object, int) - Method in class uk.ac.starlink.array.BadHandler
-
Writes a single bad value into an array.
- putBad(Object, int, int) - Method in class uk.ac.starlink.array.BadHandler
-
Writes a sequence of bad values into an array.
R
- read(Object, int, int) - Method in interface uk.ac.starlink.array.AccessImpl
-
Reads a number of pixels from the current offset into a specified part of a supplied java array.
- read(Object, int, int) - Method in interface uk.ac.starlink.array.ArrayAccess
-
Reads a number of pixels from the current offset into a specified part of a supplied primitive array.
- read(Object, int, int) - Method in class uk.ac.starlink.array.DefaultArrayAccess
- READ - Static variable in class uk.ac.starlink.array.AccessMode
-
Object representing read-only access.
- readTile(Object, NDShape) - Method in interface uk.ac.starlink.array.ArrayAccess
-
Reads a tile of pixels into a supplied primitive array.
- readTile(Object, NDShape) - Method in class uk.ac.starlink.array.DefaultArrayAccess
- releaseBuffer() - Method in interface uk.ac.starlink.array.NioArrayImpl.BufferGetter
-
Releases the NIO buffer.
- remove() - Method in class uk.ac.starlink.array.BufferIterator
-
Remove functionality is not implemented by this class.
- ReorderingMapper - Class in uk.ac.starlink.array
-
Implements the OffsetMapper interface to map between arrays with the same shape but different ordering schemes.
- ReorderingMapper(NDShape, Order, Order) - Constructor for class uk.ac.starlink.array.ReorderingMapper
-
Constructs an OffsetMapper which maps between two arrays with the same shape but different pixel sequences.
- Requirements - Class in uk.ac.starlink.array
-
Specifies a set of requirements for an array object.
- Requirements() - Constructor for class uk.ac.starlink.array.Requirements
-
Constructs a Requirements object with no specifications.
- Requirements(AccessMode) - Constructor for class uk.ac.starlink.array.Requirements
-
Constructs a Requirements object specifying a given access mode.
- ROW_MAJOR - Static variable in class uk.ac.starlink.array.Order
-
Object representing row-major (last-index-fastest) ordering.
S
- sameSequence(OrderedNDShape) - Method in class uk.ac.starlink.array.OrderedNDShape
-
Indicates whether another object represents the same pixel sequence as this.
- sameShape(NDShape) - Method in class uk.ac.starlink.array.NDShape
-
Indicates whether another object represents the same shape as this.
- scratchCopy(ArrayImpl) - Static method in class uk.ac.starlink.array.NDArrays
-
Provides an independent NDArray based on a readable ArrayImpl, with data stored in a scratch array.
- scratchCopy(NDArray) - Static method in class uk.ac.starlink.array.NDArrays
-
Provides an independent copy of a readable NDArray with data stored in a scratch array.
- ScratchNDArray - Class in uk.ac.starlink.array
-
An NDArray with data held in a fast random-access scratch array in memory or on local disk.
- ScratchNDArray(ArrayDescription) - Constructor for class uk.ac.starlink.array.ScratchNDArray
-
Constructs a scratch array with shape, type and bad value handling characteristics copied from a template ArrayDescription.
- ScratchNDArray(OrderedNDShape, Type, BadHandler) - Constructor for class uk.ac.starlink.array.ScratchNDArray
-
Constructs a scratch array with shape, type and bad value handling supplied explicitly.
- ScratchNDArray(OrderedNDShape, Type, BadHandler, ScratchNDArray.BackingStore) - Constructor for class uk.ac.starlink.array.ScratchNDArray
-
Constructs a scratch array with shape, type, bad value handling and backing store type supplied explicitly.
- ScratchNDArray.BackingStore - Class in uk.ac.starlink.array
-
Typesafe enum class enumerating the types of backing store implementation available.
- setBadHandler(BadHandler) - Method in class uk.ac.starlink.array.Requirements
-
Sets this object's required bad value handler.
- setBadValue(Number) - Method in class uk.ac.starlink.array.Requirements
-
Sets this object's required bad value handler to be one with a given bad value.
- setBuilders(ArrayBuilder[]) - Method in class uk.ac.starlink.array.NDArrayFactory
-
Sets the list of builders which actually do the URL->NDArray construction Builders earlier in the list are given a chance to handle a URL before ones later in the list.
- setMode(AccessMode) - Method in class uk.ac.starlink.array.Requirements
-
Sets an object indicating the use to which the required array will be put.
- setOffset(long) - Method in interface uk.ac.starlink.array.AccessImpl
-
Sets the offset into the array at which the next read/write will occur.
- setOffset(long) - Method in interface uk.ac.starlink.array.ArrayAccess
-
Sets the offset into the array for the next read/write to occur.
- setOffset(long) - Method in class uk.ac.starlink.array.DefaultArrayAccess
- setOrder(Order) - Method in class uk.ac.starlink.array.Requirements
-
Sets this object's required pixel ordering scheme.
- setPosition(long[]) - Method in interface uk.ac.starlink.array.ArrayAccess
-
Sets the coordinates for the next read/write to occur.
- setPosition(long[]) - Method in class uk.ac.starlink.array.DefaultArrayAccess
- setRandom(boolean) - Method in class uk.ac.starlink.array.Requirements
-
Sets a flag indicating whether random access is required.
- setShape(OrderedNDShape) - Method in class uk.ac.starlink.array.Requirements
-
Sets this object's required ordered shape (pixel sequence).
- setType(Type) - Method in class uk.ac.starlink.array.Requirements
-
Sets this object's required data type.
- setWindow(NDShape) - Method in class uk.ac.starlink.array.Requirements
-
Sets this object's required window; the shape it must have.
- SHORT - Static variable in class uk.ac.starlink.array.Type
-
Object representing primitive data of
short
type.
T
- toRequiredArray(NDArray, Requirements) - Static method in class uk.ac.starlink.array.NDArrays
-
Returns an NDArray whose type, shape, ordering scheme etc are described by a supplied
Requirements
object. - toString() - Method in class uk.ac.starlink.array.AccessMode
- toString() - Method in class uk.ac.starlink.array.BadHandler
- toString() - Method in class uk.ac.starlink.array.BridgeNDArray
- toString() - Method in class uk.ac.starlink.array.DefaultArrayAccess
- toString() - Method in class uk.ac.starlink.array.NDShape
- toString() - Method in class uk.ac.starlink.array.Order
- toString() - Method in class uk.ac.starlink.array.OrderedNDShape
- toString() - Method in class uk.ac.starlink.array.Requirements
- toString() - Method in class uk.ac.starlink.array.Type
- toString() - Method in class uk.ac.starlink.array.WrapperArrayImpl
- toString(long[]) - Static method in class uk.ac.starlink.array.NDShape
-
Returns a string representation of a position.
- toString(NDShape) - Static method in class uk.ac.starlink.array.NDShape
-
Returns a string representation of a shape.
- Type - Class in uk.ac.starlink.array
-
Primitive numeric data type identifier.
- TypeConverter - Class in uk.ac.starlink.array
-
A Converter which converts between primitive types, optionally passing the values through a real function.
- TypeConverter(Type, BadHandler, Type, BadHandler) - Constructor for class uk.ac.starlink.array.TypeConverter
-
Creates a converter from one primitive type to another.
- TypeConverter(Type, BadHandler, Type, BadHandler, Function) - Constructor for class uk.ac.starlink.array.TypeConverter
-
Creates a converter from one primitive type to another, which will pass the values through a real function prior to doing the type conversion.
U
- uk.ac.starlink.array - package uk.ac.starlink.array
- union(NDShape) - Method in class uk.ac.starlink.array.NDShape
-
Returns a NDShape giving the union of this shape and another one.
- UPDATE - Static variable in class uk.ac.starlink.array.AccessMode
-
Object representing update (read and write) access.
W
- WindowArrayImpl - Class in uk.ac.starlink.array
-
Wraps an NDArray to produce a virtual ArrayImpl with a different shape.
- WindowArrayImpl(NDArray, NDShape) - Constructor for class uk.ac.starlink.array.WindowArrayImpl
-
Constructs a new ArrayImpl from a base NDArray and a given window shape.
- within(long[]) - Method in class uk.ac.starlink.array.NDShape
-
Indicates whether a given point is within this shape.
- WrapperArrayImpl - Class in uk.ac.starlink.array
-
Base class for NDArray-wrapping implementations of ArrayImpl.
- WrapperArrayImpl(NDArray) - Constructor for class uk.ac.starlink.array.WrapperArrayImpl
- write(Object, int, int) - Method in interface uk.ac.starlink.array.AccessImpl
-
Writes a number of pixels starting at the current offset from a specified part of a supplied array.
- write(Object, int, int) - Method in interface uk.ac.starlink.array.ArrayAccess
-
Writes a number of pixels starting at the current offset from a specified part of a supplied primitive array.
- write(Object, int, int) - Method in class uk.ac.starlink.array.DefaultArrayAccess
- WRITE - Static variable in class uk.ac.starlink.array.AccessMode
-
Object representing write-only access.
- writeTile(Object, NDShape) - Method in interface uk.ac.starlink.array.ArrayAccess
-
Writes a tile of pixels from a supplied primitive array.
- writeTile(Object, NDShape) - Method in class uk.ac.starlink.array.DefaultArrayAccess
All Classes All Packages