package imagej;

/** general purpose methods */
public class Dimensions
{
	/** gets the last n-2 dimensions of a n-dimensional int array. */
	public static int[] getDims3AndGreater(int[] fullDims)
	{
		if (fullDims.length < 2)
			throw new IllegalArgumentException("Image must be at least 2-D");

		int[] extraDims = new int[fullDims.length-2];

		for (int i = 0; i < extraDims.length; i++)
			extraDims[i] = fullDims[i+2];

		return extraDims;
	}

	/** returns, as a long, the total number of samples present in an image of given dimensions */
	public static long getTotalSamples(int[] dimensions)
	{
		int numDims = dimensions.length;

		if (numDims == 0)
			return 0;

		long totalSamples = 1;

		for (int i = 0; i < numDims; i++)
			totalSamples *= dimensions[i];

		return totalSamples;
	}

	/** returns the number of planes present in an image of given dimensions. assumes the planes lie
	 *  in the 1st two dimensions
	 */
	public static long getTotalPlanes(int[] dimensions)
	{
		int numDims = dimensions.length;

		if (numDims < 2)
			return 0;

		if (numDims == 2)
			return 1;

		// else numDims > 2

		int[] sampleSpace = getDims3AndGreater(dimensions);

		return getTotalSamples(sampleSpace);
	}

	/** throws an exception if the combination of origins and spans is outside an image's dimensions */
	public static void verifyDimensions(int[] imageDimensions, int[] origin, int[] span)
	{
		// span dims should match origin dims
		if (origin.length != span.length)
			throw new IllegalArgumentException("verifyDimensions() : origin (dim="+origin.length+") and span (dim="+span.length+") arrays are of differing sizes");

		// origin/span dimensions should match image dimensions
		if (origin.length != imageDimensions.length)
			throw new IllegalArgumentException("verifyDimensions() : origin/span (dim="+origin.length+") different size than input image (dim="+imageDimensions.length+")");

		// make sure origin in a valid range : within bounds of source image
		for (int i = 0; i < origin.length; i++)
			if ((origin[i] < 0) || (origin[i] >= imageDimensions[i]))
				throw new IllegalArgumentException("verifyDimensions() : origin outside bounds of input image at index " + i);

		// make sure span in a valid range : >= 1
		for (int i = 0; i < span.length; i++)
			if (span[i] < 1)
				throw new IllegalArgumentException("verifyDimensions() : span size < 1 at index " + i);

		// make sure origin + span within the bounds of the input image
		for (int i = 0; i < span.length; i++)
			if ( (origin[i] + span[i]) > imageDimensions[i] )
				throw new IllegalArgumentException("verifyDimensions() : span range (origin+span) beyond input image boundaries at index " + i);
	}


}

@@ -2678,11 +2678,285 @@
 i);%0A%09%7D%0A%0A
+%09/** calculates the size of a plane from given width and height. Does internal calculations with longs to avoid overflow if possible. */ %0A%09public static int calcPlaneSize(int width, int height)%0A%09%7B%0A%09%09long planeSize = width;%0A%09%09planeSize *= height;%0A%09%09return (int) planeSize;%0A%09%7D
 %0A%7D%0A

add calcPlaneSize() - overflow safe calculation of plane sizes