Package ucar.nc2

Class Dimensions

java.lang.Object

ucar.nc2.Dimensions

public class Dimensions
extends Object

Static helper methods for Dimension.

Since:

10/3/2019.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Dimensions.FindDimensionByName	A Function that finds a Dimension by name.

Method Summary

Modifier and Type	Method	Description
static long	getSize(Iterable<Dimension> dimensions)	Get the total number of elements the dimensions represent.
static com.google.common.collect.ImmutableList<Dimension>	makeDimensionsAll(Variable v)	Get list of Dimensions, including parent Structure(s), if any.
static com.google.common.collect.ImmutableList<Dimension>	makeDimensionsAnon(int[] shape)	Make a list of private dimensions from an array of lengths
static com.google.common.collect.ImmutableList<Dimension>	makeDimensionsList(Dimensions.FindDimensionByName finder, String dimString)	Make a list of Dimensions from a list of names.
static String	makeDimensionsString(List<Dimension> dimensions)	Make a space-delineated String from a list of Dimension names, inverse of makeDimensionsList().
static Section.Builder	makeSectionFromDimensions(Iterable<Dimension> dimensions)	Make a ucar.ma2.Section.Builder from an ordered set of Dimension objects.
static int[]	makeShape(Iterable<Dimension> dimensions)	Make an array of Dimension lengths.

Methods inherited from class java.lang.Object

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

Method Detail

makeSectionFromDimensions

public static Section.Builder makeSectionFromDimensions(Iterable<Dimension> dimensions)

Make a ucar.ma2.Section.Builder from an ordered set of Dimension objects.

getSize

public static long getSize(Iterable<Dimension> dimensions)

Get the total number of elements the dimensions represent.

makeShape

public static int[] makeShape(Iterable<Dimension> dimensions)

Make an array of Dimension lengths.

makeDimensionsString

public static String makeDimensionsString(List<Dimension> dimensions)

Make a space-delineated String from a list of Dimension names, inverse of makeDimensionsList().

makeDimensionsList

public static com.google.common.collect.ImmutableList<Dimension> makeDimensionsList(Dimensions.FindDimensionByName finder,
                                                                                    String dimString)
                                                                             throws IllegalArgumentException

Make a list of Dimensions from a list of names.

Parameters:

finder - interface to find a Dimension by name.

dimString - space separated list of dimension names.

Returns:

equivalent list of Dimension objects.

Throws:

IllegalArgumentException - if cant find or parse the name.

makeDimensionsAnon

public static com.google.common.collect.ImmutableList<Dimension> makeDimensionsAnon(int[] shape)

Make a list of private dimensions from an array of lengths

makeDimensionsAll

public static com.google.common.collect.ImmutableList<Dimension> makeDimensionsAll(Variable v)

Get list of Dimensions, including parent Structure(s), if any.

Returns:

array of Dimension, rank of v plus all parent Structures.