DecInfo.java

/**
 * VStar: a statistical analysis tool for variable star data.
 * Copyright (C) 2010  AAVSO (http://www.aavso.org/)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>. 
 */
package org.aavso.tools.vstar.util.coords;

import org.aavso.tools.vstar.util.Triple;
import org.aavso.tools.vstar.util.prefs.NumericPrecisionPrefs;

/**
 * This class represents a Declination coordinate.
 */
public class DecInfo {

	private EpochType epoch;
	private double degs;

	/**
	 * Constructor
	 * 
	 * @param epoch
	 *            The epoch of the Dec coord.
	 * @param degrees
	 *            The degrees component of the Dec coord.
	 * @param minutes
	 *            The minutes component of the Dec coord.
	 * @param seconds
	 *            The seconds component of the Dec coord.
	 */
	public DecInfo(EpochType epoch, int degrees, int minutes, double seconds) {
		this.epoch = epoch;
		degs = Math.signum(degrees)
				* (Math.abs(degrees) + minutes / 60.0 + seconds / 3600.0);
	}

	/**
	 * Construct a DecInfo instance from decimal degrees.
	 * 
	 * @param epoch
	 *            The epoch of the Dec coord.
	 * @param dec
	 *            The Dec in decimal degrees.
	 */
	public DecInfo(EpochType epoch, double dec) {
		this.epoch = epoch;
		degs = dec;
	}

	/**
	 * @return the epoch of the Dec coord.
	 */
	public EpochType getEpoch() {
		return epoch;
	}

	public String toString() {
		return String.format("Dec (%s): %s degrees", epoch,
				NumericPrecisionPrefs.formatOther(degs));
	}

	public double toDegrees() {
		return degs;
	}

	/**
	 * Converts Declination in degrees to degrees, minutes, seconds.
	 * 
	 * @return An triple (3-tuple) containing degrees, minutes, seconds.
	 */
	public Triple<Integer, Integer, Double> toDMS() {
		double d = Math.abs(degs);
		double m = (d - (int) d) * 60;
		double s = (m - (int) m) * 60;
		return new Triple<Integer, Integer, Double>((int) (d * Math.signum(degs)),
				(int) m, s);
	}
}