net.raumzeitfalle.registration.SkippableOperation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of image-registration Show documentation

A collection of functions for image registration based on control points using rigid and affine transforms.

There is a newer version: 0.0.7

/*-
 * #%L
 * Image-Registration
 * %%
 * Copyright (C) 2019 Oliver Loeffler, Raumzeitfalle.net
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package net.raumzeitfalle.registration;

import java.util.Collection;
import java.util.function.Function;
import java.util.function.UnaryOperator;

import net.raumzeitfalle.registration.displacement.Displacement;

/**
 * Transforms are used to modify the actual displacement values (x_d, y_d). The reference (design) locations (x,y) remain unmodified.
 * A transform applies to {@link Displacement} and returns a {@link Displacement}.
 * 
 * To properly apply any given {@link Transform} to a {@link Collection} of displacements, the {@link Function} {@link TransformCorrection} shall be used.
 * {@code
 * 
 * 
 * }
 * @author oliver
 *
 */
public interface SkippableOperation extends UnaryOperator {
	
	/**
	 * When the relevant transform parameters (i.e. rotation, translation-x and y) are set to 0.0,
	 * then the transform calculation can be skipped. Transforms shall only be applied, when transform
	 * coefficients are not equal to zero.
	 * 
	 * @return boolean indicating if the given transform can be skipped.
	 */
	boolean skip();
	
}