001/*
002 * $RCSfile: PrecCoordInfo.java,v $
003 * $Revision: 1.1 $
004 * $Date: 2005/02/11 05:02:00 $
005 * $State: Exp $
006 *
007 * Class:                   PrecCoordInfo
008 *
009 * Description:             Used to store the coordinates precincts.
010 *
011 *
012 *
013 * COPYRIGHT:
014 *
015 * This software module was originally developed by Raphaël Grosbois and
016 * Diego Santa Cruz (Swiss Federal Institute of Technology-EPFL); Joel
017 * Askelöf (Ericsson Radio Systems AB); and Bertrand Berthelot, David
018 * Bouchard, Félix Henry, Gerard Mozelle and Patrice Onno (Canon Research
019 * Centre France S.A) in the course of development of the JPEG2000
020 * standard as specified by ISO/IEC 15444 (JPEG 2000 Standard). This
021 * software module is an implementation of a part of the JPEG 2000
022 * Standard. Swiss Federal Institute of Technology-EPFL, Ericsson Radio
023 * Systems AB and Canon Research Centre France S.A (collectively JJ2000
024 * Partners) agree not to assert against ISO/IEC and users of the JPEG
025 * 2000 Standard (Users) any of their rights under the copyright, not
026 * including other intellectual property rights, for this software module
027 * with respect to the usage by ISO/IEC and Users of this software module
028 * or modifications thereof for use in hardware or software products
029 * claiming conformance to the JPEG 2000 Standard. Those intending to use
030 * this software module in hardware or software products are advised that
031 * their use may infringe existing patents. The original developers of
032 * this software module, JJ2000 Partners and ISO/IEC assume no liability
033 * for use of this software module or modifications thereof. No license
034 * or right to this software module is granted for non JPEG 2000 Standard
035 * conforming products. JJ2000 Partners have full right to use this
036 * software module for his/her own purpose, assign or donate this
037 * software module to any third party and to inhibit third parties from
038 * using this software module for non JPEG 2000 Standard conforming
039 * products. This copyright notice must be included in all copies or
040 * derivative works of this software module.
041 *
042 * Copyright (c) 1999/2000 JJ2000 Partners.
043 * */
044package jj2000.j2k.codestream;
045
046/**
047 * This class is used to store the coordinates of precincts.
048 * */
049public class PrecCoordInfo extends CoordInfo {
050
051    /** Horizontal upper left coordinate in the reference grid */
052    public int xref;
053
054    /** Vertical upper left coordinate on the reference grid */
055    public int yref;
056
057    /**
058     * Constructor. Creates a PrecCoordInfo object.
059     *
060     * @param ulx Horizontal upper left coordinate in the subband
061     *
062     * @param uly Vertical upper left coordinate in the subband
063     *
064     * @param w Precint's width
065     *
066     * @param h Precinct's height
067     *
068     * @param xref The horizontal coordinate on the reference grid
069     *
070     * @param yref The vertical coordinate on the reference grid
071     * */
072    public PrecCoordInfo(int ulx, int uly, int w, int h,
073                        int xref, int yref) {
074        super(ulx, uly, w, h);
075        this.xref = xref;
076        this.yref = yref;
077    }
078
079    /**
080     * Empty Constructor. Creates an empty PrecCoordInfo object.
081     * */
082    public PrecCoordInfo() {
083        super();
084    }
085
086    /**
087     * Returns precinct's information in a String
088     *
089     * @return String with precinct's information
090     * */
091    public String toString() {
092        return super.toString() + ", xref="+xref+", yref="+yref;
093    }
094}