org.scijava.ops.image.geom.geom3d.DefaultCompactness Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scijava-ops-image Show documentation
Image processing operations for SciJava Ops.
The newest version!
/*
 * #%L
 * Image processing operations for SciJava Ops.
 * %%
 * Copyright (C) 2014 - 2024 SciJava developers.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */

package org.scijava.ops.image.geom.geom3d;

import java.util.function.Function;

import net.imglib2.mesh.Mesh;
import net.imglib2.type.numeric.real.DoubleType;

import org.scijava.function.Computers;
import org.scijava.ops.spi.OpDependency;

/**
 * Generic implementation of {@code geom.compactness}. Based on
 * http://www.sciencedirect.com/science/article/pii/S003132030700324X. In the
 * paper compactness is defined as area^3/volume^2. For a sphere this is
 * minimized and results in 36*PI. To get values between (0,1] we use
 * (36*PI)/(area^3/volume^2).
 *
 * @author Tim-Oliver Buchholz (University of Konstanz)
 * @implNote op names='geom.compactness', label='Geometric (3D): Compactness',
 *           priority='10000.'
 */
public class DefaultCompactness implements Computers.Arity1 {

	@OpDependency(name = "geom.boundarySize")
	private Function surfaceArea;

	@OpDependency(name = "geom.size")
	private Function volume;

	/**
	 * TODO
	 *
	 * @param input
	 * @param compactness
	 */
	@Override
	public void compute(final Mesh input, final DoubleType compactness) {
		final double s3 = Math.pow(surfaceArea.apply(input).get(), 3);
		final double v2 = Math.pow(volume.apply(input).get(), 2);
		final double c = s3 / v2;
		compactness.set((36.0 * Math.PI) / c);
	}

}