org.openimaj.vis.DataUnitsTransformer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of visualisations Show documentation

A library that contains classes for visualising various different features, such as audio and video.

There is a newer version: 1.3.5

/**
 * Copyright (c) 2011, The University of Southampton and the individual contributors.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 *   * 	Redistributions of source code must retain the above copyright notice,
 * 	this list of conditions and the following disclaimer.
 *
 *   *	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.
 *
 *   *	Neither the name of the University of Southampton nor the names of its
 * 	contributors may be used to endorse or promote products derived from this
 * 	software without specific prior written permission.
 *
 * 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 OWNER 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.
 */
/**
 *
 */
package org.openimaj.vis;


/**
 *	An interface for classes that can transform data units into renderer units
 *	based on the definition of the data axis in space.
 *
 *	@author David Dupplaw ([email protected])
 *  @created 26 Jun 2013
 *	@version $Author$, $Revision$, $Date$
 * 	@param  Colour representation for the axis renderer
 * 	@param  The type of the data units
 * 	@param  The type of the converted units
 */
public interface DataUnitsTransformer
{
	/**
	 * 	Force a precalculation of the variables required for
	 * 	the pixel transformation.
	 */
	public void precalc();

	/**
	 * 	For a given coordinate in the units of the data, will calculate
	 * 	the render coordinates
	 * @param units The unit to convert to render coordinates
	 *
	 *	@return Render coordinates
	 */
	public U calculatePosition( D units );

	/**
	 *	Calculates the data unit coordinate at the given render coordinates
	 * @param position The data rendered position to convert
	 *
	 *	@return the data units on the given axis
	 */
	public D calculateUnitsAt( U position );

	/**
	 * 	Given a specific data dimension, calculates a render dimension.
	 *
	 *	@param dimension The units/data dimension
	 *	@return The scaled dimension
	 */
	public U scaleDimension( D dimension );
}